Skip to content

Retrieve a list of payment methods

Request

Retrieve all available payment methods or filter by fiat.

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" ]
]
Response
[ { "id": "apple-pay", "name": "Apple Pay", "description": "Conveniently buy digital currency using your personal VISA or MasterCard.", "supportedFiats": [ … ] } ]