Skip to content

Retrieve a list of payment methods

Request

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 method's id as paymentMethodId when you request a quote. The supported methods and their IDs are listed in Supported Payment Methods; use this endpoint to check availability for your account at runtime.

Path
partnerstringrequired

This is the partner code provided to you during onboarding. e.g. metamask.

orderTypestringrequired

Whether to return availability for buy or sell orders.

Default:"buy"
Enum:"buy""sell"
Query
fiatstring

If the fiat is passed, then all payment methods available for the fiat will be returned. If not provided, then return all payment methods will be returned.

Headers
Acceptstring
Default:"application/json"
x-api-keystring

This is the API Key that has been provided to you during onboarding.

Example:YOUR_API_KEY
curl -i -X GET \
  'https://docs.banxa.com/_mock/products/hosted-checkout/openapi/{partner}/v2/payment-methods/{orderType}?fiat=string' \
  -H 'Accept: application/json' \
  -H 'x-api-key: YOUR_API_KEY'

Responses

List of supported payment methods.

Bodyapplication/json
Array [
idstring
Example:"apple-pay"
namestring
Example:"Apple Pay"
descriptionstring
Example:"Conveniently buy digital currency using your personal VISA or MasterCard."
supportedFiatsArray of strings
Example:
[
  "CAD"
]
restrictedCountriesArray of strings

ISO 3166-1 alpha-2 codes of countries where the method is not available. Empty when there are no restrictions.

Example:
[
  "US"
]
]
Response
[
  {
    "id": "apple-pay",
    "name": "Apple Pay",
    "description": "Conveniently buy digital currency using your personal VISA or MasterCard.",
    "supportedFiats": [ … ],
    "restrictedCountries": []
  }
]
© Banxa 2026