Skip to content

Banxa Enterprise API (0 BETA)

Official Banxa Enterprise API Specs

Download OpenAPI description
Languages
Servers
Mock server
https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi
Production environment server
https://api.banxa.com
Sandbox environment server
https://api.banxa-sandbox.com

Ramps

Enable Get and Post on ramp and off ramp

Operations
Webhooks

Identities

Enable Sharing and reliance of identity through token(sumsub), reliance or by sending us documents.

Operations
Webhooks

Price

Request a price prior to requesting a On or Off ramp transaction

Operations

Request

Request a price, prices are subject to change based on market volatility and network congestion.

Security
HMACAuth
Query
identityReferencestringrequired

A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: identityReference=c-13344
fiatstringrequired

The desired fiat

Example: fiat=AUD
cryptostringrequired

The desired crypto

Example: crypto=USDT
methodstringrequired

The payment method

Example: method=payid-bank-transfer
blockchainstringrequired

The chain for the crypto currency e.g. TRON or ETH

Example: blockchain=TRON
transactionTypestring

The type of transaction

Enum"ONRAMP""OFFRAMP"
Example: transactionType=ONRAMP
fiatAmountnumber>= 10

Required without cryptoAmount The amount in fiat currency to convert. Amount in fiat minor precision (typically 2 decimals). This locks the fiat amount; the crypto amount will be computed and rounded to the configured crypto scale. Note: due to differing decimal scales and rounding rules, converting fiat→crypto and then crypto→fiat may not return the exact original number..

cryptoAmountnumber>= 0.01

Required without fiatAmount Amount in crypto precision (token-dependent, e.g., 6–8 decimals). This locks the crypto amount; the fiat amount will be computed and rounded to the fiat scale. Note: small differences vs the reverse path are expected from precision/rounding.

curl -i -X GET \
  'https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/price?identityReference=c-13344&fiat=AUD&crypto=USDT&method=payid-bank-transfer&blockchain=TRON&transactionType=ONRAMP&fiatAmount=10&cryptoAmount=0.01' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Prices are subject to change due to market volatility and network congestion, therefore it's not recommended to cache this response for longer than 1 minute.

Price response.

Bodyapplication/json
One of:
identityReferencestring(IdentityReference)[A-Za-z0-9-]required

ASCII letters, digits, and hyphen only, A unique customer identifier provided by you. This field is required and must be unique for each customer. Please ensure you consistently reuse the same identityReference for repeat interactions with the same customer, allowing us to reliably recognize and associate their identity.

Example: "c-13344"
sourceobjectrequired
source.​fiatobjectrequired
source.​fiat.​idstringrequired

The fiat currency.

Example: "AUD"
source.​fiat.​methodstringrequired

The payment method.

Example: "payid-bank-transfer"
source.​amountstringrequired

The amount of fiat in.

Example: "100"
targetobjectrequired
target.​cryptoobjectrequired
target.​crypto.​idstringrequired

The crypto token.

Example: "USDT"
target.​crypto.​blockchainstringrequired

The blockchain that is associated with the crypto token.

Example: "TRON"
target.​amountstringrequired

The total amount of crypto out.

Example: "100"
processingFeestringrequired

The processing fee associated with the price.

Example: "1.00"
networkFeestringrequired

The network fee (gas fee) associated with the price.

Example: "1.00"
Response
application/json
{ "identityReference": "c-13344", "source": { "fiat": {}, "amount": "100" }, "target": { "crypto": {}, "amount": "100" }, "processingFee": "1.00", "networkFee": "1.00" }

Eligibility

Check eligibility for specific transactions

Operations

Limits

Check payment method/customer limits

Operations