Skip to content

Configuration

Configuration Endpoints - Retrieve supported payment methods, fiat currencies, countries, crypto currencies, and other configuration data required to build onboarding and transaction flows.

Key Operations:

  • List supported fiat currencies for on-ramp and off-ramp transactions
  • Retrieve available payment methods for a given transaction direction
  • Get supported countries and any required states or provinces
  • List supported crypto currencies for transaction setup
  • Use configuration data to pre-fill forms before pricing or ramp creation

Use Cases:

  • Populate dropdowns and selectors in your UI
  • Filter valid options based on customer choices
  • Validate transaction parameters before submission
  • Display supported onboarding and payout options

Payment Methods

Request

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 selectors for on-ramp and off-ramp journeys
  • Determine which fiat currencies are available for each payment method
  • Pre-configure transaction forms before requesting quotes or creating ramps
  • Show only valid payment options for the customer's selected transaction direction

Transaction Types:

  • onramp - Payment methods available for buying cryptocurrency with fiat
  • offramp - Payment methods available for selling cryptocurrency to fiat

Response Structure: Each payment method includes:

  • method: Unique code used in API requests
  • name: Human-readable payment method name
  • supportedFiats: Fiat currencies supported by that payment method
Security
HMACAuth
Path
transactionTypestringrequired

The transaction direction used to retrieve available payment methods.

Values:

  • onramp - Buy cryptocurrency using fiat
  • offramp - Sell cryptocurrency and receive fiat
Enum:"onramp""offramp"
Example:onramp
curl -i -X GET \
  https://docs.banxa.com/_mock/products/native-api/openapi/eapi/v0/payment-methods/onramp \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful response with supported payment methods for the selected transaction type.

Bodyapplication/json
dataArray of objects(Payment Methods)required

Array of available payment method objects

Response
Available payment methods for buying cryptocurrency
{ "data": [ {}, {}, {}, {} ] }