GET
/
exchange
/
orders
/
trade
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/orders/trade
This response has no body data.

This endpoint is ideal for low-code integrations, and can be used in place of Fetch Trade URL, which returns the trade url in JSON.

Instead, the Start trade endpoint automatically resolves to the trade URL, and is best used to initiate trades within a browser or webview.

To initiate orders natively via the API, use:

Query Parameters

​
apiKey
string
required

CEX api key

​
product
enum<string>
required

Integration product in use e.g web3 or custodial

Available options:
WEB3,
CUSTODIAL
​
orderId
string

Order ID generated for offramp trades

​
tradeType
enum<string>
required

Type of trade

Available options:
BUY,
SELL
​
fiat
string
required

Symbol of fiat currency

​
fiatAmount
number

Fiat amount

​
token
string
required

Symbol of token asset

​
tokenAmount
number

Token amount

​
networkId
string

Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105

​
address
string

Wallet address to be debited/credited in order

​
paymentChannel
string

Payment channel

​
email
string

Customer's email address

​
autoselect
boolean
default:true

Offer auto select flag

GET
/
exchange
/
orders
/
trade
curl --request GET \
  --url https://external.dev.onboardpay.co/exchange/orders/trade
This response has no body data.

This endpoint is ideal for low-code integrations, and can be used in place of Fetch Trade URL, which returns the trade url in JSON.

Instead, the Start trade endpoint automatically resolves to the trade URL, and is best used to initiate trades within a browser or webview.

To initiate orders natively via the API, use:

Query Parameters

​
apiKey
string
required

CEX api key

​
product
enum<string>
required

Integration product in use e.g web3 or custodial

Available options:
WEB3,
CUSTODIAL
​
orderId
string

Order ID generated for offramp trades

​
tradeType
enum<string>
required

Type of trade

Available options:
BUY,
SELL
​
fiat
string
required

Symbol of fiat currency

​
fiatAmount
number

Fiat amount

​
token
string
required

Symbol of token asset

​
tokenAmount
number

Token amount

​
networkId
string

Onboard blockchain network identifier or chain Id e.g Base will be base or 8453 or 0x2105

​
address
string

Wallet address to be debited/credited in order

​
paymentChannel
string

Payment channel

​
email
string

Customer's email address

​
autoselect
boolean
default:true

Offer auto select flag