# Banxa Enterprise API

Official Banxa Enterprise API Specs

Version: 0 BETA
License: MIT

## Servers

Production environment server
```
https://api.banxa.com
```

Sandbox environment server
```
https://api.banxa-sandbox.com
```

## Security

### HMACAuth

HMAC authentication using SHA256.
The URI must be used to generate the hmac signature e.g. `/eapi/v0/ramps` example:    
"POST    
/eapi/v0/ramps   
1741220905019999   
{"subPartnerId":null,"identityReference":"926553-1732538-7235638-6352926","source":{"crypto":{"id":"USDT","blockchain":"ETH","walletAddress":"0xc292474673cf1a96a96e8c56ec4f45ecf2e0b448","walletAddressMemo":null},"amount":"100"},"target":{"fiat":{"id":"AUD","method":"payid-bank-transfer","instructions":{"accountName":"Foo Bar","accountNumber":"12345678","bsb":"063123"}}}}"


Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

[Banxa Enterprise API](https://banxa-enterprise.redocly.app/_bundle/enterprise-api/@v0-beta/openapi.yaml)

## Ramps

Enable Get and Post on ramp and off ramp

### Ramps enable Fiat to Crypto and Crypto to fiat on and off ramp.

 - [POST /eapi/v0/ramps](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/ramps/createramp.md): Enables conversion between fiat and cryptocurrency in both directions.

### Ramp retrieval

 - [GET /eapi/v0/ramps/{ramp_id}](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/ramps/getramp.md): Enables retrieval of detailed information about a specific order using its unique identifier.

### Inbound message regarding the ramp status

 - [POST rampMessage](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/ramps/rampmessage.md): When a ramp transitions into a new status, the status update will be sent to the provided callback endpoint to your server.

## Identities

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

### Identity token sharing (sumsub)

 - [POST /eapi/v0/identities/token/share](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/shareidentity.md): Share customer identity

### Identity Reliance

 - [POST /eapi/v0/identities/reliance](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/identityreliance.md): Share customer identity

### Identity Document sharing

 - [POST /eapi/v0/identities/share/documents](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/shareidentitydocuments.md): Share identity documents

### Identity update

 - [PATCH /eapi/v0/identities](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/patchidentity.md): Update identity

### Identity Retrieval

 - [GET /eapi/v0/identities/{identity_reference}](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/getidentity.md): Enables retrieval of detailed information about a specific identity using the unique identityReference.

### Identity create

 - [POST /eapi/v0/identities/basic](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/createidentity.md): Low level identity onboarding

### Inbound message regarding customer Identity related messages

 - [POST identityMessage](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/identities/identitymessage.md): When a customer failed to create an order for a specific reason, the status update will be sent to the provided callback endpoint to your server.

## Price

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

### Price request

 - [GET /eapi/v0/price](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/price/getprice.md): Request a price, prices are subject to change based on market volatility and network congestion.

## Eligibility

Check eligibility for specific transactions

### Identity transaction eligibility

 - [POST /eapi/identities/transactions/eligibility](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/eligibility/identities/transactions.md): Request transaction eligibility for a specific identity

## Limits

Check payment method/customer limits

### Transaction Limits

 - [POST /eapi/v0/identities/transactions/limits](https://banxa-enterprise.redocly.app/enterprise-api/v0-beta/openapi/limits/postidentitytransactionlimits.md): 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