Business API

Appearance

Get a payment​

GET
/v2/payments/{id}

Requires COLLECTIONS_READ, granted by PAYMENTS_READ or COLLECTIONS_WRITE (bundles)

Returns a payment with its step-by-step timeline and the settled payouts that carried it. The payment can be on any account in your business.

Parameters​

Path Parameters

id*

Payment ID.

Type
string
Required
Example"8d2f4b6a-1c3e-4f5a-9b7d-2e4c6a8b0d1f"
Format
"uuid"

Responses​

OK

application/json
JSON
{
"id": "8d2f4b6a-1c3e-4f5a-9b7d-2e4c6a8b0d1f",
"depositId": "3f1c2a9e-8b4d-4c1e-9f2a-6d7e8b9c0a1b",
"status": "COMPLETED",
"mode": "SCHEDULED",
"type": "COLLECTION",
"inflowCurrency": "ZAR",
"inflowAmount": "1500.00",
"convertedCurrency": "USDC",
"convertedAmount": "82.45",
"outflowCurrency": "USDC",
"outflowAmount": "82.45",
"receivedAt": 1792660500000,
"settlementAt": 1792684950000,
"settlementStatus": "SETTLED",
"settlementRef": null,
"settlementId": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f",
"linked": true,
"payerName": "Thandi Nkosi",
"reference": "VLR4F7K2Q9",
"timeline": [
{
"type": "FUNDING",
"label": "1500.00 ZAR collected",
"status": "COMPLETE",
"data": {
"currency": "ZAR",
"amount": "1500.00"
},
"traceId": null,
"at": 1792660500000
},
{
"type": "CONVERSION",
"label": "Converted to 82.45 USDC",
"status": "COMPLETE",
"data": {
"fromCurrency": "ZAR",
"fromAmount": "1500.00",
"toCurrency": "USDC",
"toAmount": "82.45",
"rate": "18.1928",
"conversionId": "b7d9f1a3-5c2e-4b8d-a6f0-3e5c7a9b1d4f"
},
"traceId": "b7d9f1a3-5c2e-4b8d-a6f0-3e5c7a9b1d4f",
"at": 1792660565000
},
{
"type": "SWEEP",
"label": "Swept to payout account",
"status": "COMPLETE",
"data": {
"currency": "USDC",
"amount": "82.45"
},
"traceId": null,
"at": 1792660600000
},
{
"type": "SETTLEMENT",
"label": "Settled",
"status": "COMPLETE",
"data": {
"currency": "USDC",
"amount": "82.45"
},
"traceId": null,
"at": 1792684950000
}
],
"payouts": [
{
"settlementId": "c4e8a2f6-7b1d-4e3a-8c5f-9d0b1a2c3e4f",
"amount": "82.45",
"currency": "USDC",
"status": "SETTLED",
"settledAt": 1792684950000
}
]
}

Samples​

Errors

HTTPErrorWhen
400BAD_REQUESTA query parameter or field is invalid.
400-11INVALID_REQUESTThe payment ID isn't a valid UUID.
403-16098PAYMENTS_USER_ACCESS_NOT_CONFIGUREDPayments haven't been set up for your business yet.
404NOT_FOUNDNo payment with this ID exists in your business.
500INTERNAL_ERRORUnexpected error in the payments service.
502-16097EXCHANGE_API_ERRORThe payments service failed to process the request.
502EXCHANGE_API_ERRORThe payments service couldn't complete the request. Try again later.
503-16099PAYMENTS_BACKEND_PROXY_DISABLEDPayments endpoints are temporarily unavailable.

Plus the errors common to all signed endpoints.