API Reference
Start typing to search…

Create NFT Order

post
https://api.banxa.com/api/orders/nft/buy

Allows your customer to create a Fiat to NFT 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.

Building a Request for NFT Buy Orders

Buy orders require the following mandatory fields:

  • account_reference: the customer's unique ID in our system
  • purchase_reference: the customer's order ID you want to reference in your system
  • source: a supported fiat currency e.g. USD
  • source_amount: fiat currency amount NFT is listed in
  • target: cryptocurrency NFT is listed in e.g. ETH
  • wallet_address: the address associated with the cryptocurrency being purchased
  • return_url_on_success: used to return the customer to your website once the order is completed
  • meta_data nfts: used to display NFT name, image and collection name

Response

When an order is ready to be completed by the customer, you will receive the following:

Field

Description

Format

data.order.id

Unique ID for the the order

string

data.order.account_id

Banxa generated account ID for the customer and linked to the customer reference provided by you

string

data.order.account_reference

Unique customer reference provided by you

string

data.order.order_type

Order type. Indicates whether the order is a sell or buy crypto order

string

data.order.fiat_code

Fiat currency code

string

data.order.fiat_amount

Fiat currency value

decimal

data.order.coin_code

Cryptocurrency code

string

data.order.coin_amount

Cryptocurrency value

decimal

data.order.wallet_address

Cryptocurrency wallet address

string

data.order.blockchain

Blockchain network used for the cryptocurrency

array

data.order.blockchain.code

Blockchain code

string

data.order.blockchain.description

Blockchain name

string

data.order.created_at

Timestamp of order creation in UTC

string

data.order.checkout_url

URL that redirects customer to Banxa checkout

string

Language
Credentials
Header