Check Payment Status
If you want you can manually check payment status for each payment.
API endpoint:
/v2/payments/{id}
Request type: GET
The {id}
parameter should be replaced by paymentId
from the new payment response
Our response for new payment:
{
"paymentId" : "95bf1d853cf2e040f0ce219221f9b17206525941",
"amount" : 10.00,
"amountBtc": 1.00,
"currency" : "USD",
"status" : "NEW",
"remainingToPayBtc" : 0.5,
"remainingToPay" : 5.00,
"paid": 5.00,
"paidBtc": 0.5,
"paymentTime" : "2018-01-12T12:06:20Z",
"expirationTime" : "2018-01-12T12:21:20Z",
"currentTime" : "2018-01-12T15:16:32Z",
"merchantTransactionId" : "2015-03-10/123/1",
"notificationUrl" : "https://example.com/notify",
"message" : "payment for cookies",
"btcTransactions" : [
{
"btcTxId": "bb5af483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b713acba",
"btcAmount": 0.02194594,
"time": "2018-05-01T08:52:18.233Z"
},
{
"btcTxId": "4da38daaf483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b71d",
"btcAmount": 0.03194594,
"time": "2018-05-02T08:53:18.233Z"
}
],
"notificationType": "REGULAR"
}
Our response for an underpaid payment:
{
"paymentId" : "95bf1d853cf2e040f0ce219221f9b17206525941",
"amount" : 10.00,
"amountBtc": 1.00,
"currency" : "USD",
"status" : "UNDERPAID",
"remainingToPay" : 0.01,
"remainingToPayBtc" : 0.00001212,
"paid": 9.99,
"paidBtc": 0.99998788,
"paymentTime" : "2018-01-12T12:06:20Z",
"expirationTime" : "2018-01-12T12:21:20Z",
"currentTime" : "2018-01-12T15:16:32Z",
"merchantTransactionId" : "2015-03-10/123/1",
"notificationUrl" : "https://example.com/notify",
"message" : "payment for cookies",
"btcTransactions" : [
{
"btcTxId": "bb5af483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b713acba",
"btcAmount": 0.02194594,
"time": "2018-05-01T08:52:18.233Z"
},
{
"btcTxId": "4da38daaf483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b71d",
"btcAmount": 0.03194594,
"time": "2018-05-02T08:53:18.233Z"
}
],
"notificationType": "REGULAR"
}
Our response for fully and correctly paid payment:
{
"paymentId" : "95bf1d853cf2e040f0ce219221f9b17206525941",
"amount" : 10.00,
"amountBtc": 1.00,
"currency" : "USD",
"status" : "CONFIRMED",
"remainingToPay" : 0,
"remainingToPayBtc" : 0,
"paid": 10.00,
"paidBtc": 1.00,
"paymentTime" : "2018-01-12T12:06:20Z",
"expirationTime" : "2018-01-12T12:21:20Z",
"currentTime" : "2018-01-12T15:16:32Z",
"merchantTransactionId" : "2015-03-10/123/1",
"notificationUrl" : "https://example.com/notify",
"message" : "payment for cookies",
"btcTransactions" : [
{
"btcTxId": "bb5af483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b713acba",
"btcAmount": 0.02194594,
"time": "2018-05-01T08:52:18.233Z"
},
{
"btcTxId": "4da38daaf483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b71d",
"btcAmount": 0.03194594,
"time": "2018-05-02T08:53:18.233Z"
}
],
"notificationType": "REGULAR"
}
Our response for overpaid paid payment:
{
"paymentId" : "95bf1d853cf2e040f0ce219221f9b17206525941",
"amount" : 10.00,
"amountBtc": 1.00,
"currency" : "USD",
"status" : "INVALID",
"remainingToPay" : -1.0,
"remainingToPayBtc" : -0.10,
"paid": 11.00,
"paidBtc": 1.10,
"paymentTime" : "2018-01-12T12:06:20Z",
"expirationTime" : "2018-01-12T12:21:20Z",
"currentTime" : "2018-01-12T15:16:32Z",
"merchantTransactionId" : "2015-03-10/123/1",
"notificationUrl" : "https://example.com/notify",
"message" : "payment for cookies",
"btcTransactions" : [
{
"btcTxId": "bb5af483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b713acba",
"btcAmount": 0.02194594,
"time": "2018-05-01T08:52:18.233Z"
},
{
"btcTxId": "4da38daaf483bca29992fe1fb0ec75026f3b346ef1181ab8d77a92b5b564b71d",
"btcAmount": 0.03194594,
"time": "2018-05-02T08:53:18.233Z"
}
],
"notificationType": "REGULAR"
}
When paid too much, the payment will become INVALID
with negative remainingToPay
and remainingToPayBtc
.
Explanation of the fields
Name | Description |
---|---|
paymentId | A payment identifier on our side |
amount | A amount of fiat currency that is expected to be paid. |
amountBtc | A amount of BTC that is expected to be paid. |
remainingToPay | A amount of fiat that is remaining to be paid, in case when payment wasn't paid it will be equal to 'amount' from 'new payment response', useful for 'UNDERPAID' transactions |
remainingToPayBtc | Same as above but displayed in BTC |
paid | A amount of fiat that has been paid so far (for amounts less then 0.01 EUR, this can be rounded, use paidBtc to avoid rounding) |
paidBtc | Amount of BTC that was paid so far. |
currency | A currency code from the payment request. |
status | A String with the payment status. Payment statuses are explained in the separate section. |
paymentTime | A String containing a timestamp in ISO-8601 when the payment was confirmed on our side. This field is optional - it can either be omitted or set to null. |
expirationTime | A String containing a timestamp in ISO-8601 saying when the payment will expire. This is only valid for NEW payments but is always present. |
currentTime | A String containing a timestamp in ISO-8601 with the current server time for your reference. |
merchantTransactionId | A payment identifier on your side that was passed when requesting a payment |
notificationUrl | This URL will be called later with POST request when the payment is CONFIRMED |
message | This message should be saved by the client's wallet as a reminder for what the payment was made |
btcTransactions | A list of all BTC transactions associated with the payment |
notificationType | Describes type of the message sent by our server, payment responses have type REGULAR |
BTC transaction
Explanation of the field
Name | Description |
---|---|
btcTxId | Blockchain transaction id |
amountBtc | The amount of BTC that was paid. |
time | A String containing a timestamp in ISO-8601 saying when the transaction was made |