Retrieve an Order (On-Ramp or Off-Ramp)
Returns a single order by its orderId, whichever ramp it belongs to — the detail counterpart of List All Orders. The response is the on-ramp or the off-ramp order object, so read type to tell them apart.
Use it when you hold an orderId but not the ramp it came from. Unlike the per-ramp endpoints, this one also returns orders of deactivated customers.
Authorizations
Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.
Path Parameters
Unique identifier for the order.
Response
The order, in its ramp's shape.
- Option 1
- Option 2
Details of an on-ramp transaction.
Unique identifier for the on-ramp transaction.
"21d8a046-3221-4b43-a301-0f9adcdd9a45"
Date and time the on-ramp transaction was created.
Customer's unique identifier.
Reference to the original quote used for this transaction.
The source currency (fiat) used in the on-ramp transaction.
"ARS"
The target cryptocurrency received in the on-ramp transaction.
"USDC"
The amount of the target cryptocurrency received (based on the original quote).
The target blockchain network for the cryptocurrency deposit.
"ETHEREUM_SEPOLIA"
The payment method used for the fiat deposit.
"bank_transfer"
The customer's deposit address on the target blockchain.
Indicates the origin of the on-ramp order.
ON_RAMP, ON_RAMP_SESSION "ON_RAMP"
Additional metadata associated with the transaction.
Transaction hash of the on-chain withdrawal to the customer's depositAddress. null until the crypto has been sent, and populated once it has.
null
Name of the holder of the originating fiat account (e.g. CVU/CLABE owner). Null when not provided by the fiat provider.
"Juan Pérez"
Current state of the on-ramp order.
PENDING, PROCESSING, COMPLETED, CANCELLED, REFUNDED "COMPLETED"
Whether a fiat refund can be requested for this order right now. Computed per request, so use it to decide whether to call the refund endpoint instead of discovering it through a 400.
false
Whether requesting a refund for this order requires naming a destination fiatAccountId. false means the money is returned to the account the customer paid from and a fiatAccountId is rejected. null when the order is not in refund territory.
false
State of the most recent refund of this order's deposit, or null if there never was one. The only place a rejected refund request is visible.