API Reference

Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Payment Methods

List Payment Methods

GET/accounts/{account_id}/payment-methods

Create Payment Method

POST/accounts/{account_id}/payment-methods

Get Payment Method

GET/accounts/{account_id}/payment-methods/{payment_method_id}

Update Payment Method

PUT/accounts/{account_id}/payment-methods/{payment_method_id}

Delete Payment Method

DELETE/accounts/{account_id}/payment-methods/{payment_method_id}

Set Default Payment Method

POST/accounts/{account_id}/payment-methods/{payment_method_id}/set-as-default

ModelsExpand Collapse

PaymentMethodListResponse object { id, address, address2, 22 more }

id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode: optional string

Billing zip code.

PaymentMethodCreateResponse object { id, address, address2, 22 more }

id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode: optional string

Billing zip code.

PaymentMethodGetResponse object { id, address, address2, 22 more }

id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode: optional string

Billing zip code.

PaymentMethodUpdateResponse object { id, address, address2, 22 more }

id: optional string

Payment method identifier.

address: optional string

Billing address line 1.

address2: optional string

Billing address line 2.

bank_account_type: optional string

Bank account type.

bank_code: optional string

Bank code.

bank_country: optional string

Bank country.

bank_name: optional string

Bank name for bank-based payment methods.

bank_routing_number: optional string

Bank routing number.

cashapp_cash_tag: optional string

Cash App cash tag.

city: optional string

Billing city.

country: optional string

Billing country.

default: optional boolean

Whether this is the default payment method.

device_data: optional string

Device data for fraud prevention.

expiration_date: optional string

Card expiration date.

first_name: optional string

Billing first name.

last_four: optional string

Last four digits of the card number.

last_name: optional string

Billing last name.

nick_name: optional string

A nickname for the payment method.

payment_account_email: optional string

Email associated with the payment account.

payment_email: optional string

Payment email address.

payment_gateway: optional string

The payment gateway used.

payment_nonce: optional string

Payment nonce for tokenized payments.

state: optional string

Billing state.

type: optional "CREDIT_CARD" or "PAYPAL" or "CASHAPP" or 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode: optional string

Billing zip code.

PaymentMethodDeleteResponse = unknown or string

One of the following:

unknown

string

PaymentMethodSetAsDefaultResponse = unknown or string

One of the following:

unknown

string