# Hosted Checkout API

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

The Banxa Hosted Checkout API lets you list the fiats, cryptocurrencies, countries and payment methods available to your account, get quotes, create buy and sell orders that return a Banxa checkout URL, look up orders, and share a customer's Sumsub KYC token. Authenticate with your API key in the `x-api-key` header, except when sharing a KYC token, which is signed with HMAC. Use `https://api.banxa-sandbox.com` while testing and `https://api.banxa.com` in production. See [Authentication and environments](https://docs.banxa.com/products/hosted-checkout/docs/getting-started/authentication-and-environments).

Version: v2

## Servers

```
https://api.banxa.com
```

## Security

### sec0

Type: apiKey
In: header
Name: x-api-key

## Download OpenAPI description

 - [Hosted Checkout API](https://docs.banxa.com/_bundle/products/hosted-checkout/openapi.yaml)

 - [GET /{partner}/v2/fiats/{orderType}](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-list-of-fiats.md): Returns the fiat currencies available to your partner account for `buy` or `sell` orders. Each currency lists the payment methods that accept it, with the minimum and maximum amount for each, so you c
 - [GET /{partner}/v2/crypto/{orderType}](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-list-of-cryptocurrencies.md): Returns the cryptocurrencies available to your partner account for `buy` or `sell` orders. Each asset lists the blockchains it can be sent on, with the default blockchain, token contract address, chai
 - [GET /{partner}/v2/countries](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-list-of-countries.md): Returns the countries Banxa supports, each with its `id` and display name, and with its `states` where they apply. The list is the same for buy and sell orders. See [Geographic and asset restrictions]
 - [GET /{partner}/v2/payment-methods/{orderType}](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-list-of-payment-methods.md): Returns the payment methods available to your partner account for `buy` or `sell` orders, with the fiat currencies each one accepts. Pass `fiat` to return only the methods for that currency. Use a met
 - [GET /{partner}/v2/quotes/{orderType}](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-quotes.md): Allows you to retrieve a detailed quote for a user order. This endpoint should only be called when a user requests a quote by providing the cryptocurrency, fiat, amounts and payment method. This endpo
 - [POST /{partner}/v2/buy](https://docs.banxa.com/products/hosted-checkout/openapi/other/create-a-buy-order.md): Allows your customer to create a buy crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to
 - [GET /{partner}/v2/orders/{orderId}](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-specific-order.md): Returns one order by its Banxa order ID: its status, crypto and fiat amounts, fees, payment method, and the asset, blockchain and wallet address. Use it to check an order's status, for example after a
 - [GET /{partner}/v2/orders](https://docs.banxa.com/products/hosted-checkout/openapi/other/retrieve-a-list-of-orders.md): Retrieves details for a bulk of orders that have been submitted within a given time range and optionally by order status or customer.
 - [POST /{partner}/v2/sell](https://docs.banxa.com/products/hosted-checkout/openapi/other/create-a-sell-order.md): Allows your customer to create a sell crypto order with Banxa. Upon success, the response will contain a checkout URL which will be unique for the order. The customer will be redirected to this URL to
 - [POST /{partner}/v2/identities/token/share](https://docs.banxa.com/products/hosted-checkout/openapi/other/share-identity-token.md): Share a customer's Sumsub identity token with Banxa before creating an order. Banxa uses the token to retrieve KYC details directly from Sumsub, reducing re-verification friction in the checkout flow.