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

Eligibility

Check eligibility for specific transactions

Operations

Limits

Check payment method/customer limits

Operations

Request

Returns applicable transaction limits for a given identity and transaction context.

Limits are derived from:

  • payment-provider limits (route/method specific), and
  • customer-specific limits (tier-based and/or overrides)

The response returns:

  • limits for DAILY/WEEKLY/MONTHLY/ANNUAL windows, including provider vs customer sources
Security
HMACAuth
Bodyapplication/jsonrequired
identityReferencestring[ 1 .. 255 ] charactersrequired

Partner identity reference.

Example: "206-0x56c386b7b49be8618dbcdb2c6d09e161645c31ed"
methodstring[ 1 .. 100 ] charactersrequired

Payment method / route identifier.

Example: "payid-bank-transfer"
transactionTypestringrequired

Transaction type (e.g., ONRAMP/OFFRAMP). Populate enum from your TransactionTypeEnum if desired.

Example: "ONRAMP"
fiatstring[ 1 .. 10 ] characters^[A-Z0-9]{1,10}$required

Fiat currency code (typically ISO 4217).

Example: "AUD"
cryptostring[ 1 .. 10 ] characters^[A-Z0-9]{1,10}$required

Crypto asset code.

Example: "BTC"
blockchainstring[ 1 .. 50 ] charactersrequired

Blockchain identifier.

Example: "BTC"
curl -i -X POST \
  https://banxa-enterprise.redocly.app/_mock/enterprise-api/v0-beta/openapi/eapi/v0/identities/transactions/limits \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "identityReference": "206-0x56c386b7b49be8618dbcdb2c6d09e161645c31ed",
    "method": "payid-bank-transfer",
    "fiat": "AUD",
    "crypto": "BTC",
    "blockchain": "BTC",
    "transactionType": "ONRAMP"
  }'

Responses

Limits result

Bodyapplication/json
identityReferencestringrequired

Echo of the identity reference.

Example: "206-0x56c386b7b49be8618dbcdb2c6d09e161645c31ed"
limitsobjectrequired
limits.​transactionobject
limits.​periodicalArray of objects(LimitBucket)

List of limit buckets for each time period.

Response
application/json
{ "identityReference": "206-0x56c386b7b49be8618dbcdb2c6d09e161645c31ed", "limits": { "transaction": {}, "periodical": [] } }