Skip to main content
GET
Retrieve an Off-Ramp Order

Authorizations

Authorization
string
header
required

Access token obtained via /oauth2/token/. Use as Authorization: Bearer <access_token>.

Path Parameters

orderId
string<uuid>
required

Unique identifier for the order.

Response

The off-ramp order.

Details of an off-ramp transaction.

transactionId
string<uuid>
required

Unique identifier for the off-ramp transaction.

createdAt
string<date-time>
required

Date and time the off-ramp transaction was created.

customerId
string<uuid>
required

Customer's unique identifier.

quoteId
string<uuid>
required

Reference to the original quote used for this transaction.

fromCurrency
string
required

The source cryptocurrency being off-ramped.

Example:

"USDC"

toCurrency
string
required

The target fiat currency received.

Example:

"ARS"

amount
string
required

The amount of the target currency transferred or to be transferred.

chain
string
required

The cryptocurrency blockchain for the deposit address.

Example:

"ETHEREUM"

metadata
object

Additional metadata associated with the transaction.

Example:
txnHash
string | null

The transaction hash of the customer's incoming crypto deposit. null until the deposit is detected on-chain.

Example:

null

providerId
string

The fiat withdrawal provider's transaction identifier. Available for completed Argentine off-ramp orders.

finishedAt
string

Date and time the fiat withdrawal was completed by the provider. Available for completed Argentine off-ramp orders.

fiatAccountId
string<uuid>

Identifier of the fiat account the payout is sent to.

refundAddress
string | null

The effective on-chain refund address for this order, if any.

refundable
boolean

Whether a crypto 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.

Example:

false

refundDestinationRequired
boolean | null

Whether requesting a refund for this order requires naming a refundAddress. false means the crypto is returned to the deposit's on-chain origin address and an address is rejected. null when the order is not in refund territory.

Example:

false

latestRefund
object | null

State of the most recent refund of this order's crypto deposit, or null if there never was one. On this ramp only a completed refund emits an event (OFF-RAMP.ORDER.REFUNDED), so this block is how progress is followed and the only way a rejection is ever read.

refundedTxnHash
string | null

On-chain hash of the crypto refund, once refunded. null otherwise.

Example:

null