Read a Payment
const url = 'https://api.voltpay.space/v1/payments/pay_6f1c%E2%80%A6';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.voltpay.space/v1/payments/pay_6f1c%E2%80%A6 \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Example
pay_6f1c…Responses
Section titled “Responses”The Payment.
object
Derived from the Transfer, so one Transfer can never become two Payments.
seen may still be reversed. confirmed is Final or accepted early. reversed disappeared after being confirmed.
The Merchant’s own identifier for a Checkout, unique per Merchant and Mode.
An amount in USD. Each Coin counts as 1 USD.
What actually arrived, kept exactly. The Merchant credits this.
An on-chain amount in integer base units, as a string because it can exceed any JSON number.
The Coin’s decimals on this Network. BSC uses 18, most others 6.
How the amount that arrived compares with the Checkout.
The evidence that matched the Transfer to the Checkout. A sender or transaction hash a Payer posted is never evidence.
One blockchain. Test mode uses the test Network codes.
The coin, identified on-chain by its contract and never by this symbol.
The Coin’s contract on this Network.
The Receive Address the money went to.
The on-chain sender.
Example
{ "id": "pay_6f1c…", "status": "seen", "checkout_id": "chk_01J9…", "reference": "DEP20261106123456", "requested_amount": "50.00", "amount": "49.0037", "amount_base_units": "49003700", "decimals": 6, "match_result": "exact", "matched_by": "exact_amount", "network": "tron", "coin": "usdt", "contract": "TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t", "address": "TSeJkUh4Qv67VNFwY8LaAxERygNdy6NQZK", "address_name": "Main TRON 3", "confirmed_by": "final", "fee": "49.0037"}INVALID_API_KEY: the key is missing, wrong or revoked.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "INVALID_API_KEY", "message": "The API key is missing, wrong or revoked.", "request_id": "req_01J9…" }}MERCHANT_SUSPENDED: Staff have suspended the Merchant.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "MERCHANT_SUSPENDED", "message": "This account is suspended. Contact support.", "request_id": "req_01J9…" }}PAYMENT_NOT_FOUND: no such Payment.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "PAYMENT_NOT_FOUND", "message": "No Payment has that id.", "request_id": "req_01J9…" }}RATE_LIMITED: back off, per Retry-After.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "RATE_LIMITED", "message": "Too many requests. Wait for the time in Retry-After, then try again.", "request_id": "req_01J9…" }}Headers
Section titled “Headers”Seconds to wait before trying again.
INTERNAL: an unexpected failure. Quote request_id when reporting it.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "INTERNAL", "message": "Something went wrong on our side. Quote the request id if this continues.", "request_id": "req_01J9…" }}TRY_AGAIN: a time limit cut the request short and nothing was committed.
object
object
The stable identifier a client branches on.
For people. May be reworded, so never branch on it.
More about the failure. For VALIDATION_ERROR, a map of field name to reason.
object
Only with CHECKOUT_LIMIT_EXCEEDED. The largest Checkout the Merchant may create now, in micro-USD.
Examples
{ "error": { "code": "TRY_AGAIN", "message": "Nothing was committed. Try the request again.", "request_id": "req_01J9…" }}Headers
Section titled “Headers”Seconds to wait before trying again.