List payment methods

Authorizations

Authorization

string

header

required

A JWT signed using your CDP API Key Secret, encoded in base64. Refer to the Generate Bearer Token section of our Authentication docs for information on how to generate your Bearer Token.

Query Parameters

pageSize

integer

default:20

The number of resources to return per page.

pageToken

string

The token for the next page of resources, if any.

Response

The list of payment methods.

paymentMethods

object[]

required

Show child attributes

paymentMethods.id

string

required

The identifier of the payment method.

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

paymentMethods.type

enum<string>

required

The type of payment method.

Payment methods represent different rails for moving money. Common values include:

ach - Automated Clearing House transfers for US bank accounts
fedwire - Federal Reserve Wire Network transfers for US bank accounts

Available options:

ach,

fedwire

Example:

"ach"

paymentMethods.asset

string

required

Asset symbol for the payment method.

Example:

"usd"

paymentMethods.name

string

Name for the payment method.

Example:

"ALLY BANK ******1234"

paymentMethods.verified

boolean

The verified status of the payment method.

Example:

true

paymentMethods.allowDeposit

boolean

Whether or not this payment method can perform deposits.

Example:

true

paymentMethods.allowWithdraw

boolean

Whether or not this payment method can perform withdrawals.

Example:

false

paymentMethods.allowOutboundPayment

boolean

Whether or not this payment method can perform outbound payments.

Example:

true

paymentMethods.limits

object[]

List of ACH limits for the payment method.

Show child attributes

paymentMethods.limits.remaining

object

The remaining amount available in the limit.

Show child attributes

paymentMethods.limits.remaining.amount

string

required

Numeric value representing the amount.

Example:

"1000.00"

paymentMethods.limits.remaining.asset

string

required

Asset symbol (currency code) for the amount.

Example:

"usd"

Example:

{ "amount": "1000.00", "asset": "usd" }

paymentMethods.limits.used

object

The amount already used from the limit.

Show child attributes

paymentMethods.limits.used.amount

string

required

Numeric value representing the amount.

Example:

"500.00"

paymentMethods.limits.used.asset

string

required

Asset symbol (currency code) for the amount.

Example:

"usd"

Example:

{ "amount": "500.00", "asset": "usd" }

paymentMethods.limits.total

object

The total limit amount.

Show child attributes

paymentMethods.limits.total.amount

string

required

Numeric value representing the amount.

Example:

"1500.00"

paymentMethods.limits.total.asset

string

required

Asset symbol (currency code) for the amount.

Example:

"usd"

Example:

{ "amount": "1500.00", "asset": "usd" }

paymentMethods.limits.limitPeriod

enum<string>

Period of the limit.

unknown The period is unknown.
daily The limit is daily.
weekly The limit is weekly.
monthly The limit is monthly.
biweekly The limit is bi-weekly.

Available options:

unknown,

daily,

weekly,

monthly,

biweekly

Example:

"daily"

paymentMethods.limits.description

string

The description of the limit.

Example:

"Daily ACH transfer limit."

Example:

[
  {
    "remaining": { "amount": "900.00", "asset": "usd" },
    "used": { "amount": "100.00", "asset": "usd" },
    "total": { "amount": "1000.00", "asset": "usd" },
    "limitPeriod": "daily",
    "description": "Daily ACH transfer limit."
  }
]

nextPageToken

string

The token for the next page of items, if any.

Example:

"eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="

CDP PAYMENTS API

REST API

Authorizations

Query Parameters

Response