# Banxa Native API

Official Banxa Enterprise API Specs

> For the complete documentation index, see [llms.txt](https://docs.banxa.com/llms.txt). Append `.md` to any page URL for its markdown version.

Version: 0 BETA
License: MIT

## Servers

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

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

## Security

### HMACAuth

[object Object]

Type: apiKey
In: header
Name: Authorization

## Download OpenAPI description

 - [Banxa Native API](https://docs.banxa.com/_bundle/products/native-api/@v0-beta/openapi.yaml)

## Ramps (Transactions)

 - [GET /eapi/v0/ramps](https://docs.banxa.com/products/native-api/openapi/ramps/listramps.md): Retrieve a paginated list of transfer orders (ramps). **Pagination Modes**: - **Cursor Pagination**: Use `startAfter`, `endBefore`, or `cursor` parameters. Dates are optional. - **Offset Pagination**:
 - [POST /eapi/v0/ramps](https://docs.banxa.com/products/native-api/openapi/ramps/createramp.md): Enables conversion between fiat and cryptocurrency in both directions.
 - [GET /eapi/v0/ramps/{ramp_id}](https://docs.banxa.com/products/native-api/openapi/ramps/getramp.md): Enables retrieval of detailed information about a specific order using its unique identifier.
 - [POST rampMessage](https://docs.banxa.com/products/native-api/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 (KYC)

 - [POST /eapi/v0/identities/share/token](https://docs.banxa.com/products/native-api/openapi/identities/shareidentity.md): Share customer identity
 - [POST /eapi/v0/identities/reliance](https://docs.banxa.com/products/native-api/openapi/identities/identityreliance.md): Share customer identity
 - [GET /eapi/v0/identities/{identity_reference}](https://docs.banxa.com/products/native-api/openapi/identities/getidentity.md): Enables retrieval of detailed information about a specific identity using the unique identityReference.
 - [POST /eapi/v0/identities/basic](https://docs.banxa.com/products/native-api/openapi/identities/createidentity.md): Low level identity onboarding
 - [POST /eapi/v0/identities/share/documents](https://docs.banxa.com/products/native-api/openapi/identities/shareidentitydocuments.md): Share identity documents for KYC verification. **Use Case**: Submit customer identity documents directly to Banxa for verification. **Process**: 1. Collect customer information and documents 2. Submit
 - [PATCH /eapi/v0/identities](https://docs.banxa.com/products/native-api/openapi/identities/patchidentity.md): Update specific fields of an existing customer identity. **Use Case**: Update customer information without resubmitting all documents. **Partial Updates**: Only include fields you want to update. Omit
 - [POST identityMessage](https://docs.banxa.com/products/native-api/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.
## Quote

 - [GET /eapi/v0/quote](https://docs.banxa.com/products/native-api/openapi/quote/getquote.md): Request a quote with a locked price and a unique `quoteId`. The quote is valid for **3 minutes** (`expiresAt`). Unique identifier for this quote. Use this when creating a ramp transaction via the Ramp
## Price (Indicative)

 - [GET /eapi/v0/price](https://docs.banxa.com/products/native-api/openapi/price/getprice.md): Request an indicative, non-persisted price. The returned price is a point-in-time estimate and is **not** stored or locked — it carries no `quoteId` and cannot be referenced later. Use this endpoint f
## Eligibility (Pre-checks)

 - [POST /eapi/v0/identities/transactions/eligibility](https://docs.banxa.com/products/native-api/openapi/eligibility/checkeligibility.md): Request transaction eligibility for a specific identity
## Limits (Transaction Limits)

 - [POST /eapi/v0/identities/transactions/limits](https://docs.banxa.com/products/native-api/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-ba
## Verifications (OTP)

 - [POST /eapi/v0/verifications/otp](https://docs.banxa.com/products/native-api/openapi/verifications/requestotp.md): Sends a one-time password (OTP) code to the customer's email address for verification. The OTP code is valid for a limited time and can only be used once. Rate limited to 3 requests per minute per cus
 - [POST /eapi/v0/verifications/otp/verify](https://docs.banxa.com/products/native-api/openapi/verifications/verifyotp.md): Verifies the OTP code sent to the customer's email address. Upon successful verification, the customer's email is marked as verified. OTP codes are single-use and expire after a set time period. Rate
## Configuration

 - [GET /eapi/v0/payment-methods/{transactionType}](https://docs.banxa.com/products/native-api/openapi/configuration/listpaymentmethods.md): Retrieve supported payment methods for the specified transaction type as part of the configuration data required to build onboarding and transaction flows. **Use Cases**: - Populate payment method sel
 - [GET /eapi/v0/cryptocurrencies/{transactionType}](https://docs.banxa.com/products/native-api/openapi/configuration/listcryptocurrencies.md): Retrieve supported cryptocurrencies for the specified transaction type as part of the configuration data required to build onboarding and transaction flows. **Use Cases**: - Display available cryptocu
 - [GET /eapi/v0/fiats/{transactionType}](https://docs.banxa.com/products/native-api/openapi/configuration/listfiats.md): Retrieve a list of supported fiat currencies for the specified transaction type (onramp or offramp). **Use Cases**: - Display available fiat currencies to customers during onboarding - Filter payment
 - [GET /eapi/v0/countries](https://docs.banxa.com/products/native-api/openapi/configuration/listcountries.md): Retrieve supported countries for KYC and transaction flows as part of the configuration data required to build onboarding and transaction flows. **Use Cases**: - Populate country dropdowns during cust