# Banxa Native API

Banxa Native API is Banxa’s fully API-driven integration model for partners building deeply integrated digital asset experiences.

It enables platforms to embed fiat on-ramps and off-ramps directly within their own product environment, while Banxa provides the regulated payments, compliance, and settlement infrastructure behind the scenes.

Partners retain full control over authentication, onboarding flows, and user experience.
Banxa handles transaction execution, regulatory obligations, and asset delivery.

## Designed for Platform-Controlled Experiences

The Banxa Native API is built for platforms that require:

- Full control of front-end UX and session management
- API-driven identity, eligibility, and limits orchestration
- Flexible KYC models aligned to existing onboarding infrastructure
- Programmatic transaction lifecycle management


No mandatory hosted onboarding or embedded UI components are required.

Payment execution models vary by rail:

- Bank transfers are fully API-driven
- Cards, Apple Pay, and Google Pay require SDK-based secure payment handling


## Core Capabilities

Identities
Manage customer identity and compliance state using a persistent `identityReference`.

Supported models:

- Basic identity creation (low-tier / KYC-free where permitted)
- KYC provider token sharing (e.g. Sumsub)
- Identity reliance (partner CIP submission)
- Document submission (full verification)
- Identity updates


Eligibility
Evaluate whether a specific transaction is permitted based on:

- Identity state
- Payment method
- Transaction type
- Fiat / crypto pair
- Blockchain
- Regulatory context


Eligibility responses may indicate additional KYC requirements.

Limits
Retrieve applicable transaction limits for a given identity and transaction context. Limits reflect:

- Provider-level constraints
- Customer-tier limits
- Time-based buckets (daily, weekly, monthly, annual)


Limits are designed to be evaluated prior to transaction initiation.

Price
Retrieve real-time pricing and fee breakdowns prior to order creation.

Used for transaction estimation and user-facing quotes.

Ramps
Create and retrieve on-ramp and off-ramp transactions.

Includes:

- Order creation (fiat → crypto / crypto → fiat)
- Transaction status retrieval
- Lifecycle state changes via webhook


Webhooks
Receive real-time notifications for:

- Ramp lifecycle state changes
- Compliance-related customer status changes


Webhook deliveries require a 2xx response. Non-2xx responses will trigger retry attempts.