Skip to main content
GET
List Payment Options

Authorizations

Authorization
string
header
required

Bearer Authentication

Headers

X-BU-PROFILE-ID
string

User profile header

Example:

"BUS_YOK8tp5Zga01qOKEsqp07"

Query Parameters

currency
string

The currency to get payment options for.

Example:

"USD"

support_conversion
boolean

This shows if the payment options is supported for conversions

type
enum<string>

The type of payment options to retrieve.

Available options:
withdraw,
deposit
Example:

"withdraw"

amount
number

The amount to get payment options for.

Example:

1500

purpose
enum<string>

Filter payment options by intended use case.

Available options:
wallet,
auto_save,
auto_buy,
savings,
loans

Response

Payment Options List Response

General response Values

status
enum<string>
required
Available options:
success,
error
Example:

"success"

message
string
required
Example:

"message for success"

data
object[]
required