exchange-external-api
Fetch trade url
get/exchange/api/orders/trade-url
Request
- Base URLhttps://external.dev.onboardpay.co
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
apiKeystring required
CEX api key
product'WEB3' | 'CUSTODIAL' required
Integration product in use e.g web3 or custodial
orderIdstring
Order ID generated for offramp trades
tradeType'BUY' | 'SELL' required
Type of trade
fiatstring required
Symbol of fiat currency
fiatAmountnumber
Fiat amount
tokenstring required
Symbol of token asset
tokenAmountnumber
Token amount
networkIdstring
Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105
addressstring
Wallet address to be debited/credited in order
paymentChannelstring
Payment channel
emailstring
Customer's email address
autoselectboolean
Offer auto select flag
Response
Success
Changes
No recorded changes to this operation across all 22 revisions of this API.