off-ramp

Get off-ramp order

Returns a single order by its ID.

get/api/offramp/order/{id}

Request

Base URL
https://sandbox-api.fonbnk.com
Auth
- API key in header x-client-id
- or API key in header x-timestamp
- or API key in header x-signature
TypeScript
https://skmtc.dev/fonbnk/apis/fonbnk-on-ramp-api/docs/api/offramp/order/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring required

Successful response

_idstring

offerIdstring

paymentType'CRYPTO_WALLET' | 'VIRTUAL_WALLET'

network'AVALANCHE' | 'POLYGON' | 'CELO' | 'ETHEREUM'

asset'USDC' | 'USDT' | 'CUSD' | 'CKES'

exchangeRatenumber

fromAddressstring

toAddressstring

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

No recorded changes to this operation across all 1 revision of this API.