Create Order

post

https://api.banxa.com/api/orders

Allows your customer to create a buy or sell crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to complete the checkout process, which will expire after 1 minute if a redirect does not occur.

Body Params

account_reference

string

required

Unique customer reference provided by you. Used to check whether customer has completed KYC.

payment_method_id

int32

Payment method ID associated with the order.

source

string

required

Source currency or cryptocurrency code. This parameter indicates whether the order is a buy or a sell cryptocurrency order.

source_amount

string

Source amount

target

string

required

Target currency or cryptocurrency code. This parameter indicates whether the order is a buy or a sell cryptocurrency order.

target_amount

string

Target amount. This will be overridden if a source_amount is also passed.

wallet_address

string

required

Wallet address to receive cryptocurrency. Should be sent for buy cryptocurrency orders only.

wallet_address_tag

string

required

Wallet tag or memo associated with the wallet address. Should be sent for buy cryptocurrency orders only. This is required when the Customer's wallet address has a Memo or Tag such as BNB (Memo) and XRP (Tag).

blockchain

string

Blockchain network code. If not provided, the default blockchain configured for the cryptocurrency will be used. Refer to the Get Crypto Currencies endpoint to retrieve a list of supported blockchain network codes.

return_url_on_success

string

required

Return URL when the customer has completed the checkout process.

return_url_on_cancelled

string

Return URL when the customer cancels the checkout process.

return_url_on_failure

string

Return URL when the customer fails to complete the checkout process.

meta_data

string

Free form string that you can use to send us any information that will be returned in the Get Orders endpoint

refund_address

string

required

Refund wallet address. Should be sent for sell cryptocurrency orders only. Used in the event in the event that a refund is necessary and the transferred coins need to be returned.

refund_address_tag

string

Refund wallet address tag or memo. Should be sent for sell cryptocurrency orders only. This is required when the Customer's wallet address has a Memo or Tag such as BNB (Memo) and XRP (Tag).

source_address

string

Source wallet address. Should be sent for sell cryptocurrency orders only.

source_address_tag

string

Source wallet address tag or memo. Should be sent for sell cryptocurrency orders only. Required when source wallet address for BNB (Memo) or XRP (Tag).

string

Customer's email address. This will pre-populate the customers' email address field when they are redirected to Banxa checkout

mobile

string

Customer's mobile number. This will pre-populate the customers' mobile number field when they are redirected to Banxa checkout

discount_code

string

Defaults to VIP

(Beta) A code that can be passed to change your commission rate on this order. Please contact your account manager for code setup.

Headers

string

Defaults to application/json

X-Request-Id

string

This is the correlation ID related to the request.

Responses

200200

422422