API Reference

Accounts

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Payment Methods

List Payment Methods

client.accounts.paymentMethods.list(PaymentMethodListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<PaymentMethodListResponse { id, address, address2, 22 more } >

GET/accounts/{account_id}/payment-methods

Create Payment Method

client.accounts.paymentMethods.create(PaymentMethodCreateParams { account_id, address, address2, 20 more } params, RequestOptionsoptions?): PaymentMethodCreateResponse { id, address, address2, 22 more }

POST/accounts/{account_id}/payment-methods

Get Payment Method

client.accounts.paymentMethods.get(stringpaymentMethodID, PaymentMethodGetParams { account_id } params, RequestOptionsoptions?): PaymentMethodGetResponse { id, address, address2, 22 more }

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

Update Payment Method

client.accounts.paymentMethods.update(stringpaymentMethodID, PaymentMethodUpdateParams { account_id, address, address2, 20 more } params, RequestOptionsoptions?): PaymentMethodUpdateResponse { id, address, address2, 22 more }

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

Delete Payment Method

client.accounts.paymentMethods.delete(stringpaymentMethodID, PaymentMethodDeleteParams { account_id } params, RequestOptionsoptions?): PaymentMethodDeleteResponse

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

Set Default Payment Method

client.accounts.paymentMethods.setAsDefault(stringpaymentMethodID, PaymentMethodSetAsDefaultParams { account_id } params, RequestOptionsoptions?): PaymentMethodSetAsDefaultResponse

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

ModelsExpand Collapse

PaymentMethodListResponse { id, address, address2, 22 more }

id?: string

Payment method identifier.

address?: string

Billing address line 1.

address2?: string

Billing address line 2.

bank_account_type?: string

Bank account type.

bank_code?: string

Bank code.

bank_country?: string

Bank country.

bank_name?: string

Bank name for bank-based payment methods.

bank_routing_number?: string

Bank routing number.

cashapp_cash_tag?: string

Cash App cash tag.

city?: string

Billing city.

country?: string

Billing country.

default?: boolean

Whether this is the default payment method.

device_data?: string

Device data for fraud prevention.

expiration_date?: string

Card expiration date.

first_name?: string

Billing first name.

last_four?: string

Last four digits of the card number.

last_name?: string

Billing last name.

nick_name?: string

A nickname for the payment method.

payment_account_email?: string

Email associated with the payment account.

payment_email?: string

Payment email address.

payment_gateway?: string

The payment gateway used.

payment_nonce?: string

Payment nonce for tokenized payments.

state?: string

Billing state.

type?: "CREDIT_CARD" | "PAYPAL" | "CASHAPP" | 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode?: string

Billing zip code.

PaymentMethodCreateResponse { id, address, address2, 22 more }

id?: string

Payment method identifier.

address?: string

Billing address line 1.

address2?: string

Billing address line 2.

bank_account_type?: string

Bank account type.

bank_code?: string

Bank code.

bank_country?: string

Bank country.

bank_name?: string

Bank name for bank-based payment methods.

bank_routing_number?: string

Bank routing number.

cashapp_cash_tag?: string

Cash App cash tag.

city?: string

Billing city.

country?: string

Billing country.

default?: boolean

Whether this is the default payment method.

device_data?: string

Device data for fraud prevention.

expiration_date?: string

Card expiration date.

first_name?: string

Billing first name.

last_four?: string

Last four digits of the card number.

last_name?: string

Billing last name.

nick_name?: string

A nickname for the payment method.

payment_account_email?: string

Email associated with the payment account.

payment_email?: string

Payment email address.

payment_gateway?: string

The payment gateway used.

payment_nonce?: string

Payment nonce for tokenized payments.

state?: string

Billing state.

type?: "CREDIT_CARD" | "PAYPAL" | "CASHAPP" | 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode?: string

Billing zip code.

PaymentMethodGetResponse { id, address, address2, 22 more }

id?: string

Payment method identifier.

address?: string

Billing address line 1.

address2?: string

Billing address line 2.

bank_account_type?: string

Bank account type.

bank_code?: string

Bank code.

bank_country?: string

Bank country.

bank_name?: string

Bank name for bank-based payment methods.

bank_routing_number?: string

Bank routing number.

cashapp_cash_tag?: string

Cash App cash tag.

city?: string

Billing city.

country?: string

Billing country.

default?: boolean

Whether this is the default payment method.

device_data?: string

Device data for fraud prevention.

expiration_date?: string

Card expiration date.

first_name?: string

Billing first name.

last_four?: string

Last four digits of the card number.

last_name?: string

Billing last name.

nick_name?: string

A nickname for the payment method.

payment_account_email?: string

Email associated with the payment account.

payment_email?: string

Payment email address.

payment_gateway?: string

The payment gateway used.

payment_nonce?: string

Payment nonce for tokenized payments.

state?: string

Billing state.

type?: "CREDIT_CARD" | "PAYPAL" | "CASHAPP" | 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode?: string

Billing zip code.

PaymentMethodUpdateResponse { id, address, address2, 22 more }

id?: string

Payment method identifier.

address?: string

Billing address line 1.

address2?: string

Billing address line 2.

bank_account_type?: string

Bank account type.

bank_code?: string

Bank code.

bank_country?: string

Bank country.

bank_name?: string

Bank name for bank-based payment methods.

bank_routing_number?: string

Bank routing number.

cashapp_cash_tag?: string

Cash App cash tag.

city?: string

Billing city.

country?: string

Billing country.

default?: boolean

Whether this is the default payment method.

device_data?: string

Device data for fraud prevention.

expiration_date?: string

Card expiration date.

first_name?: string

Billing first name.

last_four?: string

Last four digits of the card number.

last_name?: string

Billing last name.

nick_name?: string

A nickname for the payment method.

payment_account_email?: string

Email associated with the payment account.

payment_email?: string

Payment email address.

payment_gateway?: string

The payment gateway used.

payment_nonce?: string

Payment nonce for tokenized payments.

state?: string

Billing state.

type?: "CREDIT_CARD" | "PAYPAL" | "CASHAPP" | 3 more

The payment method type.

One of the following:

"CREDIT_CARD"

"PAYPAL"

"CASHAPP"

"SEPA_DEBIT"

"LINK"

"ACH_DIRECT_DEBIT"

zipcode?: string

Billing zip code.

PaymentMethodDeleteResponse = unknown | string | null

One of the following:

unknown

string | null

PaymentMethodSetAsDefaultResponse = unknown | string | null

One of the following:

unknown

string | null