Sign in

v1

latestOpenAPI 3.1.02026-07-2372117.5 KB
off-ramp

Get off-ramp order

Returns a single order by its ID.

get/api/offramp/order/{id}

Path parameters

idstring required

Response

Successful response

_idstring
offerIdstring
paymentType'CRYPTO_WALLET' | 'VIRTUAL_WALLET'
  • CRYPTO_WALLET: User will pay with a crypto wallet
  • VIRTUAL_WALLET: Order will be paid from a merchant's virtual wallet
network'AVALANCHE' | 'POLYGON' | 'CELO' | 'ETHEREUM'
asset'USDC' | 'USDT' | 'CUSD' | 'CKES'
exchangeRatenumber
fromAddressstring
toAddressstring
status'initiated' | 'awaiting_transaction_confirmation' | 'transaction_confirmed' | 'transaction_failed' | 'offramp_success' | 'offramp_pending' | 'offramp_failed' | 'offramp_retry' | 'refunding' | 'refunded' | 'refund_failed' | 'expired' | 'cancelled' | 'validating_transaction' | 'transaction_invalid'
  • initiated: The offramp order has been initiated
  • awaiting_transaction_confirmation: User sent the transaction hash and system is awaiting confirmation
  • transaction_confirmed: User transaction has been confirmed
  • transaction_failed: User transaction has failed
  • offramp_success: The offramp transaction has been successful
  • offramp_pending: The offramp transaction is pending
  • offramp_failed: The offramp transaction has failed
  • offramp_retry: The offramp transaction is being retried
  • refunding: The offramp transaction is being refunded
  • refunded: The offramp transaction has been refunded
  • refund_failed: The offramp transaction refund has failed
  • expired: The offramp order has expired
  • cancelled: The offramp order has been cancelled by the user
  • validating_transaction: The offramp transaction is being validated
  • transaction_invalid: The offramp transaction is invalid
createdAtstring date-time
expiresAtstring date-time
hashstring
requiredFieldsobject

Fields that was required to be filled by the user

countryIsoCodestring
userPhoneNumberstring
userEmailstring
currencyIsoCodestring
orderParamsstring