Skip to main content
GET
Retrieve an Order (On-Ramp or Off-Ramp)

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 order, in its ramp's shape.

Details of an on-ramp transaction.

transactionId
string<uuid>
required

Unique identifier for the on-ramp transaction.

Example:

"21d8a046-3221-4b43-a301-0f9adcdd9a45"

createdAt
string<date-time>
required

Date and time the on-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 currency (fiat) used in the on-ramp transaction.

Example:

"ARS"

toCurrency
string
required

The target cryptocurrency received in the on-ramp transaction.

Example:

"USDC"

amount
string
required

The amount of the target cryptocurrency received (based on the original quote).

chain
string
required

The target blockchain network for the cryptocurrency deposit.

Example:

"ETHEREUM_SEPOLIA"

paymentMethodType
string
required

The payment method used for the fiat deposit.

Example:

"bank_transfer"

depositAddress
string
required

The customer's deposit address on the target blockchain.

source
enum<string>
required

Indicates the origin of the on-ramp order.

Available options:
ON_RAMP,
ON_RAMP_SESSION
Example:

"ON_RAMP"

metadata
object

Additional metadata associated with the transaction.

Example:
txnHash
string | null

Transaction hash of the on-chain withdrawal to the customer's depositAddress. null until the crypto has been sent, and populated once it has.

Example:

null

sender
string | null

Name of the holder of the originating fiat account (e.g. CVU/CLABE owner). Null when not provided by the fiat provider.

Example:

"Juan Pérez"

status
enum<string>

Current state of the on-ramp order.

Available options:
PENDING,
PROCESSING,
COMPLETED,
CANCELLED,
REFUNDED
Example:

"COMPLETED"

refundable
boolean

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.

Example:

false

refundDestinationRequired
boolean | null

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.

Example:

false

latestRefund
object | null

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.