Skip to main content

​
Interfaces

​
GetPaymentMethodRequest

Defined in: _vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts:13

​
Example

{
    paymentMethodId: "paymentMethod_8e03978e-40d5-43e8-bc93-6894a57f9324"
}

​
Properties

paymentMethodId
paymentMethodId: string;
Defined in: _vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts:15 The unique identifier of the payment method.

​
ListPaymentMethodsRequest

Defined in: _vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:11

​
Example

{
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}

​
Properties

pageSize?
optional pageSize: number;
Defined in: _vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:13 The number of resources to return per page.
pageToken?
optional pageToken: string;
Defined in: _vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:15 The token for the next page of resources, if any.

​
ListPaymentMethodsResponse

Defined in: _vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:5

​
Properties

nextPageToken?
optional nextPageToken: string;
Defined in: _vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:9 The token for the next page of items, if any.
paymentMethods
paymentMethods: PaymentMethodsPaymentMethod[];
Defined in: _vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:7 The list of payment methods.

​
Namespaces

​
Interfaces

​
EmailInstrument

Defined in: _vendor/api/types/EmailInstrument.ts:8 The target of the payment is an email address.

​
Properties

asset
asset: string;
Defined in: _vendor/api/types/EmailInstrument.ts:12 Asset symbol of the payment received by the recipient.
email
email: string;
Defined in: _vendor/api/types/EmailInstrument.ts:10 The email address of the recipient. The recipient will need to have an account with Coinbase or onboard to Coinbase to receive the payment.

​
FedwireDetails

Defined in: _vendor/api/types/FedwireDetails.ts:6 Details specific to Fedwire (domestic USD wire) payment methods.

​
Properties

accountLast4
accountLast4: string;
Defined in: _vendor/api/types/FedwireDetails.ts:12 The last 4 digits of the bank account number.
asset
asset: string;
Defined in: _vendor/api/types/FedwireDetails.ts:8 The asset for this payment method. Always usd for Fedwire.
bankName
bankName: string;
Defined in: _vendor/api/types/FedwireDetails.ts:10 The name of the bank.
routingNumber
routingNumber: string;
Defined in: _vendor/api/types/FedwireDetails.ts:14 The ABA routing number of the bank.

​
FedwirePaymentMethod

Defined in: _vendor/api/types/FedwirePaymentMethod.ts:8 A Fedwire (domestic USD wire) payment method linked to your entity.

​
Extended by

​
Properties

active
active: boolean;
Defined in: _vendor/api/types/FedwirePaymentMethod.ts:11 Whether the payment method is active and can be used in transfers. A payment method may be inactive due to verification requirements or entity-level restrictions.
createdAt
createdAt: string;
Defined in: _vendor/api/types/FedwirePaymentMethod.ts:13 The timestamp when the payment method was created.
fedwire
fedwire: FedwireDetails;
Defined in: _vendor/api/types/FedwirePaymentMethod.ts:17 Fedwire (domestic USD wire) details.
paymentMethodId
paymentMethodId: string;
Defined in: _vendor/api/types/FedwirePaymentMethod.ts:9
updatedAt
updatedAt: string;
Defined in: _vendor/api/types/FedwirePaymentMethod.ts:15 The timestamp when the payment method was last updated.

​
OriginatingBankAccountUs

Defined in: _vendor/api/types/OriginatingBankAccountUs.ts:6 The originating US bank account details for the transfer source. Present when funds were deposited from an external bank account into a deposit destination. Only the last 4 digits of the account number are exposed.

​
Properties

accountLast4
accountLast4: string;
Defined in: _vendor/api/types/OriginatingBankAccountUs.ts:10 The last 4 digits of the originating bank account number.
bankName
bankName: string;
Defined in: _vendor/api/types/OriginatingBankAccountUs.ts:8 The name of the bank that originated the deposit.
currency
currency: string;
Defined in: _vendor/api/types/OriginatingBankAccountUs.ts:12 The fiat currency of the deposit (e.g., usd).

​
PaymentMethod

Defined in: _vendor/api/types/PaymentMethod.ts:8 The Payment Method specific details for the transfer.

​
Properties

asset
asset: string;
Defined in: _vendor/api/types/PaymentMethod.ts:11
paymentMethodId
paymentMethodId: string;
Defined in: _vendor/api/types/PaymentMethod.ts:10 The ID of the Payment Method.

​
SepaDetails

Defined in: _vendor/api/types/SepaDetails.ts:6 Details specific to SEPA (Single Euro Payments Area) payment methods.

​
Properties

asset
asset: string;
Defined in: _vendor/api/types/SepaDetails.ts:8 The asset for this payment method. Always eur for SEPA.
bankName
bankName: string;
Defined in: _vendor/api/types/SepaDetails.ts:10 The name of the bank.
bic
bic: string;
Defined in: _vendor/api/types/SepaDetails.ts:14 The Bank Identifier Code (BIC) / SWIFT code.
ibanLast4
ibanLast4: string;
Defined in: _vendor/api/types/SepaDetails.ts:12 The last 4 characters of the IBAN.

​
SepaPaymentMethod

Defined in: _vendor/api/types/SepaPaymentMethod.ts:8 A SEPA (Single Euro Payments Area) payment method linked to your entity.

​
Extended by

​
Properties

active
active: boolean;
Defined in: _vendor/api/types/SepaPaymentMethod.ts:11 Whether the payment method is active and can be used in transfers. A payment method may be inactive due to verification requirements or entity-level restrictions.
createdAt
createdAt: string;
Defined in: _vendor/api/types/SepaPaymentMethod.ts:13 The timestamp when the payment method was created.
paymentMethodId
paymentMethodId: string;
Defined in: _vendor/api/types/SepaPaymentMethod.ts:9
sepa
sepa: SepaDetails;
Defined in: _vendor/api/types/SepaPaymentMethod.ts:17 SEPA (Single Euro Payments Area) details.
updatedAt
updatedAt: string;
Defined in: _vendor/api/types/SepaPaymentMethod.ts:15 The timestamp when the payment method was last updated.

​
SwiftDetails

Defined in: _vendor/api/types/SwiftDetails.ts:6 Details specific to SWIFT (international wire) payment methods.

​
Properties

accountLast4
accountLast4: string;
Defined in: _vendor/api/types/SwiftDetails.ts:12 The last 4 characters of the account identifier. For IBAN-based accounts (e.g., EU), this is the last 4 characters of the IBAN. For account number-based accounts (e.g., US), this is the last 4 digits of the account number.
asset
asset: string;
Defined in: _vendor/api/types/SwiftDetails.ts:8 The asset for this payment method (e.g., eur, gbp).
bankName
bankName: string;
Defined in: _vendor/api/types/SwiftDetails.ts:10 The name of the bank.
bic
bic: string;
Defined in: _vendor/api/types/SwiftDetails.ts:16 The Bank Identifier Code (BIC) / SWIFT code.
ibanLast4?
optional ibanLast4: string;
Defined in: _vendor/api/types/SwiftDetails.ts:14 Deprecated: use accountLast4 instead. The last 4 characters of the account identifier.

​
SwiftPaymentMethod

Defined in: _vendor/api/types/SwiftPaymentMethod.ts:8 A SWIFT (international wire) payment method linked to your entity.

​
Extended by

​
Properties

active
active: boolean;
Defined in: _vendor/api/types/SwiftPaymentMethod.ts:11 Whether the payment method is active and can be used in transfers. A payment method may be inactive due to verification requirements or entity-level restrictions.
createdAt
createdAt: string;
Defined in: _vendor/api/types/SwiftPaymentMethod.ts:13 The timestamp when the payment method was created.
paymentMethodId
paymentMethodId: string;
Defined in: _vendor/api/types/SwiftPaymentMethod.ts:9
swift
swift: SwiftDetails;
Defined in: _vendor/api/types/SwiftPaymentMethod.ts:17 SWIFT (international wire) details.
updatedAt
updatedAt: string;
Defined in: _vendor/api/types/SwiftPaymentMethod.ts:15 The timestamp when the payment method was last updated.

​
Type Aliases