exchange-external-api
Retrieve list of exchange orders
Changed onget/exchange/api/orders
Request
- Base URLhttps://external.dev.onboardpay.co
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
fromstring date
15-04-2022
tostring date
15-08-2022
sizeinteger
pageinteger
transactionType'ONRAMP' | 'OFFRAMP'
statusesGet Exchange Orders External Statuses Enum[]
tokenstring
fiatstring
networkstring
Response
Success
Example response
{
"orders": [
{
"reference": "0165359005113074501885",
"customerName": "John Doe",
"offer": {
"rate": 0.32,
"networkId": "TRC20",
"fiatSymbol": "NGN",
"fiatAmount": 120.5,
"token": "USDT",
"tokenAmount": 120.5,
"partnerDisplayName": "John Doe"
},
"paymentChannelId": "BANK_TRANSFER_NIGERIA",
"customerWallet": {
"networkId": "bsc_testnet",
"walletName": "My Trust Wallet"
}
}
]
}Changes
- info
the endpoint scheme security
HMACAuthwas added to the API - info
the endpoint scheme security
authTokenwas removed from the API
- info