Get a collection
Returns the status and details of a collection. Pass the transaction_id from the create call, the charge call or a webhook. The id in this response is a different value.
Path Parameters
The collection's transaction_id
Query Parameters
Send true to include the payer details in enriched_info
Possible values: true, false
Responses
| Status | Description |
|---|---|
200 |
The collection |
400 |
The request failed. An unknown ID returns transaction not found: resource not found. |
200 response
Internal record ID. It is not the collection ID, so do not use it with this endpoint.
Status of the collection. pending also covers expired, cancelled and voided collections; read onramp_status for the step.
Possible values: pending, completed, failed, refunded, refund_pending, disputed
The step the collection is at. Until 2026-10-31T23:59:59Z this has the old label, such as provider_success. After that date it has the new label, such as payment_succeeded. Read new_onramp_status to get the new label today.
Possible values: created, initialized, initialize, pending, awaiting_capture, provider_initiated, provider_success, provider_failed, provider_voided, transfer_queued, transfer_initialized, transfer_success, transfer_failed, transfer_completed, settlement_abandoned, abandoned, expired, cancelled, refund_initiated, refunded, refund_failed, chargeback_opened, chargeback_won, chargeback_lost, suspected_fraud, pending_review
The step the collection is at, with the new label. Sent until 2026-10-31T23:59:59Z, when onramp_status takes the same values.
Possible values: created, initialized, initialize, pending, awaiting_capture, payment_initiated, payment_succeeded, payment_failed, payment_voided, settlement_queued, settlement_initiated, settlement_succeeded, settlement_failed, settlement_completed, settlement_abandoned, abandoned, expired, cancelled, refund_initiated, refunded, refund_failed, chargeback_opened, chargeback_won, chargeback_lost, suspected_fraud, pending_review
When onramp_status switches to the new labels. Sent until then.
Always 0. Collection fees are billed to you separately.
The amount in cents
Country name, such as Nigeria
Currency name, such as United States Dollar
Method display name, such as Credit/Debit Card
Payment status reported by the payment network
Possible values: card, bank_transfer, mobile_money, wire_transfer, pix, digital_wallet
On-chain hash. Set once the collection settles.
Machine code when the collection failed, such as ABANDONED or a decline code like INSUFFICIENT_FUNDS.
A short sentence for error_code
Possible values: approved, pending, declined
Payer details. Sent only when enrich=true.
Status history
{
"data": {
"id": "5b0d7c1e-2f7e-4c55-9a51-0d4c1a6c2e11",
"transaction_status": "completed",
"onramp_status": "transfer_completed",
"new_onramp_status": "settlement_completed",
"status_transition_deadline": "2026-10-31T23:59:59Z",
"amount": "50.00",
"asset": "USDC",
"network": "polygon",
"customer_id": "04dfb2e5-1274-4214-b5fd-3415fde7dc17",
"client_reference": "order-1001",
"fee_cents": 0,
"total_amount_cents": 5000,
"country": "Nigeria",
"currency": "United States Dollar",
"payment_method": "Credit/Debit Card",
"transaction_source": "card",
"destination_wallet_address": "0x445906a6766927c5da8b2fca0e0db5d7b5565ef8",
"web3_tx_hash": "0x56713ddd7478bbe69925a4aa477d9cb74b56c4c041a304ca3160b2289b6e3a44",
"card_brand": "VISA",
"card_last4": "1111",
"approval_state": "approved",
"three_ds_status": "not_required",
"created_at": "2026-10-12T09:14:03Z",
"status_updated_at": "2026-10-12T09:21:40Z",
"completed_at": "2026-10-12T09:21:40Z",
"events": [
{
"event_type": "payment_initiated",
"title": "Payment initiated",
"date": "2026-10-12T09:14:03Z"
}
]
},
"error": null
}
400 response
{
"data": null,
"error": "transaction not found: resource not found"
}
Authorization
- ApiKeyAuth