Skip to content

Latest commit

 

History

History
176 lines (121 loc) · 6.57 KB

PaymentApi.md

File metadata and controls

176 lines (121 loc) · 6.57 KB
Raw

Payrobot\PaymentApi

All URIs are relative to https://api.payrobot.io

Method HTTP request Description
createPayment POST /{currency}/payments Generate a new one-use address to receive a payment
getPayment GET /{currency}/payments/{paymentId} Get detailed information about a payment

createPayment

\Payrobot\Model\PaymentRequest createPayment($currency, $type, $destination, $amount, $callback, $reference)

Generates a new one-use address to receive a payment. It callbacks your web/app server as soon as it's paid and confirmed.

Payment can be forwarded to another address or it can be stored in a payrobot.io wallet

Important

  • Unpaid requests are deleted after 3 hours of theirs creation
  • Confirmed payments information is deleted after 3 days of being confirmed

Minimum Amounts

  • Bitcoin: 0.0001 BTC
  • Litecoin: 0.001 LTC
  • Bitcoin Cash: 0.001 BCH

Callbacks

A payment notificacion will be sent to your callback url in the following scenarios:

  1. Payment is received partially
  2. Payment is being confirmed by network
  3. Payment is confirmed at least with 1 confirmation

The callback sent to your callback url is a POST request with the following parameters:

Example:

currency:         "BTC"
paymentId:        "698fd3f6-5482-4798-8a46-6732af440616"
address:          "3KoUDMfrov91G4SXaCKGvTWDjGia9Jod5b"
type:             0
partialAmount:    "0.00"
                  //Partial amount received when payment is incomplete
remainingAmount:  "0.00"
                  //Remaining amount to pay when payment is incomplete
amount:           "0.1"
feePct:           0.90
feeAmount:        "0.0009"
finalAmount:      "0.0991"
destination:      "698fd3f6-5482-4798-8a46-6732af440616"
reference:        "12345"
status:           2

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Payrobot\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$currency = 'ltc'; // string | Object Currency:   * `btc`: Bitcoin   * `ltc`: Litecoin   * `bch`: Bitcoin Cash
$type = 0; // int | * `0: Receive and forward` payment is forwarded to a desired coin address once it's confirmed  * `1: Receive and store` payment is stored in a payrobot.io wallet
$destination = 'ltc1q5zwsf58jxr3d0rnp5nlq6xjeath2gvptwpu92r'; // string | * For `Receive and forward` payment is the `ADDRESS` where the payment is going to be forwarded as soon as it's confirmed. **ADDRESS HAVE TO BE OF THE SAME TYPE OF CURRENCY**  * For `Receive and store` payment is the payrobot.io `WALLET ID` where the payment is going to be stored as soon as it's confirmed. **WALLET HAVE TO BE OF THE SAME TYPE OF CURRENCY**
$amount = 3.4; // float | Amount of the payment
$callback = 'https://callback-url.com'; // string | Your URL where payrobot.io will send the status of the payment (Webhook)
$reference = 'Bill12345'; // string | Optional custom reference to identify the payment

try {
    $result = $apiInstance->createPayment($currency, $type, $destination, $amount, $callback, $reference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->createPayment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
currency string Object Currency: * `btc`: Bitcoin * `ltc`: Litecoin * `bch`: Bitcoin Cash
type int * `0: Receive and forward` payment is forwarded to a desired coin address once it's confirmed * `1: Receive and store` payment is stored in a payrobot.io wallet
destination string * For `Receive and forward` payment is the `ADDRESS` where the payment is going to be forwarded as soon as it's confirmed. ADDRESS HAS TO BE OF THE SAME TYPE OF CURRENCY * For `Receive and store` payment is the payrobot.io `WALLET ID` where the payment is going to be stored as soon as it's confirmed. WALLET HAS TO BE OF THE SAME TYPE OF CURRENCY
amount float Amount of the payment
callback string Your URL where payrobot.io will send the status of the payment (Webhook)
reference string Optional custom reference to identify the payment [optional]

Return type

\Payrobot\Model\PaymentRequest

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPayment

\Payrobot\Model\PaymentRequest getPayment($currency, $paymentId)

Get detailed information about a payment

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Payrobot\Api\PaymentApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$currency = 'btc'; // string | Object Currency:   * `btc`: Bitcoin   * `ltc`: Litecoin   * `bch`: Bitcoin Cash
$paymentId = '698fd3f6-5482-4798-8a46-6732af440616'; // string | Payment ID to query

try {
    $result = $apiInstance->getPayment($currency, $paymentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentApi->getPayment: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
currency string Object Currency: * `btc`: Bitcoin * `ltc`: Litecoin * `bch`: Bitcoin Cash
paymentId string Payment ID to query

Return type

\Payrobot\Model\PaymentRequest

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]