> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cdp.coinbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Types

## Interfaces

### GetPaymentMethodRequest

Defined in: [\_vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts#L13)

#### Example

```ts theme={null}
{
    paymentMethodId: "paymentMethod_8e03978e-40d5-43e8-bc93-6894a57f9324"
}
```

#### Properties

##### paymentMethodId

```ts theme={null}
paymentMethodId: string;
```

Defined in: [\_vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/client/requests/GetPaymentMethodRequest.ts#L15)

The unique identifier of the payment method.

***

### ListPaymentMethodsRequest

Defined in: [\_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts#L11)

#### Example

```ts theme={null}
{
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}
```

#### Properties

##### pageSize?

```ts theme={null}
optional pageSize: number;
```

Defined in: [\_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts#L13)

The number of resources to return per page.

##### pageToken?

```ts theme={null}
optional pageToken: string;
```

Defined in: [\_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/client/requests/ListPaymentMethodsRequest.ts#L15)

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

***

### ListPaymentMethodsResponse

Defined in: [\_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:5](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts#L5)

#### Properties

##### nextPageToken?

```ts theme={null}
optional nextPageToken: string;
```

Defined in: [\_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts#L9)

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

##### paymentMethods

```ts theme={null}
paymentMethods: PaymentMethodsPaymentMethod[];
```

Defined in: [\_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts:7](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/paymentMethods/types/ListPaymentMethodsResponse.ts#L7)

The list of payment methods.

## Namespaces

* [PaymentMethodsPaymentMethod](/sdks/cdp-sdks-v2/typescript/PaymentMethods/namespaces/PaymentMethodsPaymentMethod/index)

## Interfaces

### EmailInstrument

Defined in: [\_vendor/api/types/EmailInstrument.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/EmailInstrument.ts#L8)

The target of the payment is an email address.

#### Properties

##### asset

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/types/EmailInstrument.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/EmailInstrument.ts#L12)

Asset symbol of the payment received by the recipient.

##### email

```ts theme={null}
email: string;
```

Defined in: [\_vendor/api/types/EmailInstrument.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/EmailInstrument.ts#L10)

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](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwireDetails.ts#L6)

Details specific to Fedwire (domestic USD wire) payment methods.

#### Properties

##### accountLast4

```ts theme={null}
accountLast4: string;
```

Defined in: [\_vendor/api/types/FedwireDetails.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwireDetails.ts#L12)

The last 4 digits of the bank account number.

##### asset

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/types/FedwireDetails.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwireDetails.ts#L8)

The asset for this payment method. Always `usd` for Fedwire.

##### bankName

```ts theme={null}
bankName: string;
```

Defined in: [\_vendor/api/types/FedwireDetails.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwireDetails.ts#L10)

The name of the bank.

##### routingNumber

```ts theme={null}
routingNumber: string;
```

Defined in: [\_vendor/api/types/FedwireDetails.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwireDetails.ts#L14)

The ABA routing number of the bank.

***

### FedwirePaymentMethod

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L8)

A Fedwire (domestic USD wire) payment method linked to your entity.

#### Extended by

* [`Fedwire`](/sdks/cdp-sdks-v2/typescript/PaymentMethods/namespaces/PaymentMethodsPaymentMethod/index#fedwire)

#### Properties

##### active

```ts theme={null}
active: boolean;
```

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L11)

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

```ts theme={null}
createdAt: string;
```

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L13)

The timestamp when the payment method was created.

##### fedwire

```ts theme={null}
fedwire: FedwireDetails;
```

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:17](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L17)

Fedwire (domestic USD wire) details.

##### paymentMethodId

```ts theme={null}
paymentMethodId: string;
```

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L9)

##### updatedAt

```ts theme={null}
updatedAt: string;
```

Defined in: [\_vendor/api/types/FedwirePaymentMethod.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/FedwirePaymentMethod.ts#L15)

The timestamp when the payment method was last updated.

***

### OriginatingBankAccountUs

Defined in: [\_vendor/api/types/OriginatingBankAccountUs.ts:6](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/OriginatingBankAccountUs.ts#L6)

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

```ts theme={null}
accountLast4: string;
```

Defined in: [\_vendor/api/types/OriginatingBankAccountUs.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/OriginatingBankAccountUs.ts#L10)

The last 4 digits of the originating bank account number.

##### bankName

```ts theme={null}
bankName: string;
```

Defined in: [\_vendor/api/types/OriginatingBankAccountUs.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/OriginatingBankAccountUs.ts#L8)

The name of the bank that originated the deposit.

##### currency

```ts theme={null}
currency: string;
```

Defined in: [\_vendor/api/types/OriginatingBankAccountUs.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/OriginatingBankAccountUs.ts#L12)

The fiat currency of the deposit (e.g., `usd`).

***

### PaymentMethod

Defined in: [\_vendor/api/types/PaymentMethod.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/PaymentMethod.ts#L8)

The Payment Method specific details for the transfer.

#### Properties

##### asset

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/types/PaymentMethod.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/PaymentMethod.ts#L11)

##### paymentMethodId

```ts theme={null}
paymentMethodId: string;
```

Defined in: [\_vendor/api/types/PaymentMethod.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/PaymentMethod.ts#L10)

The ID of the Payment Method.

***

### SepaDetails

Defined in: [\_vendor/api/types/SepaDetails.ts:6](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaDetails.ts#L6)

Details specific to SEPA (Single Euro Payments Area) payment methods.

#### Properties

##### asset

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/types/SepaDetails.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaDetails.ts#L8)

The asset for this payment method. Always `eur` for SEPA.

##### bankName

```ts theme={null}
bankName: string;
```

Defined in: [\_vendor/api/types/SepaDetails.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaDetails.ts#L10)

The name of the bank.

##### bic

```ts theme={null}
bic: string;
```

Defined in: [\_vendor/api/types/SepaDetails.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaDetails.ts#L14)

The Bank Identifier Code (BIC) / SWIFT code.

##### ibanLast4

```ts theme={null}
ibanLast4: string;
```

Defined in: [\_vendor/api/types/SepaDetails.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaDetails.ts#L12)

The last 4 characters of the IBAN.

***

### SepaPaymentMethod

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L8)

A SEPA (Single Euro Payments Area) payment method linked to your entity.

#### Extended by

* [`Sepa`](/sdks/cdp-sdks-v2/typescript/PaymentMethods/namespaces/PaymentMethodsPaymentMethod/index#sepa)

#### Properties

##### active

```ts theme={null}
active: boolean;
```

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L11)

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

```ts theme={null}
createdAt: string;
```

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L13)

The timestamp when the payment method was created.

##### paymentMethodId

```ts theme={null}
paymentMethodId: string;
```

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L9)

##### sepa

```ts theme={null}
sepa: SepaDetails;
```

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:17](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L17)

SEPA (Single Euro Payments Area) details.

##### updatedAt

```ts theme={null}
updatedAt: string;
```

Defined in: [\_vendor/api/types/SepaPaymentMethod.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SepaPaymentMethod.ts#L15)

The timestamp when the payment method was last updated.

***

### SwiftDetails

Defined in: [\_vendor/api/types/SwiftDetails.ts:6](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L6)

Details specific to SWIFT (international wire) payment methods.

#### Properties

##### accountLast4

```ts theme={null}
accountLast4: string;
```

Defined in: [\_vendor/api/types/SwiftDetails.ts:12](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L12)

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

```ts theme={null}
asset: string;
```

Defined in: [\_vendor/api/types/SwiftDetails.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L8)

The asset for this payment method (e.g., `eur`, `gbp`).

##### bankName

```ts theme={null}
bankName: string;
```

Defined in: [\_vendor/api/types/SwiftDetails.ts:10](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L10)

The name of the bank.

##### bic

```ts theme={null}
bic: string;
```

Defined in: [\_vendor/api/types/SwiftDetails.ts:16](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L16)

The Bank Identifier Code (BIC) / SWIFT code.

##### ibanLast4?

```ts theme={null}
optional ibanLast4: string;
```

Defined in: [\_vendor/api/types/SwiftDetails.ts:14](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftDetails.ts#L14)

Deprecated: use `accountLast4` instead. The last 4 characters of the account identifier.

***

### SwiftPaymentMethod

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:8](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L8)

A SWIFT (international wire) payment method linked to your entity.

#### Extended by

* [`Swift`](/sdks/cdp-sdks-v2/typescript/PaymentMethods/namespaces/PaymentMethodsPaymentMethod/index#swift)

#### Properties

##### active

```ts theme={null}
active: boolean;
```

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:11](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L11)

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

```ts theme={null}
createdAt: string;
```

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:13](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L13)

The timestamp when the payment method was created.

##### paymentMethodId

```ts theme={null}
paymentMethodId: string;
```

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:9](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L9)

##### swift

```ts theme={null}
swift: SwiftDetails;
```

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:17](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L17)

SWIFT (international wire) details.

##### updatedAt

```ts theme={null}
updatedAt: string;
```

Defined in: [\_vendor/api/types/SwiftPaymentMethod.ts:15](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/types/SwiftPaymentMethod.ts#L15)

The timestamp when the payment method was last updated.

## Type Aliases

* [Email](/sdks/cdp-sdks-v2/typescript/PaymentMethods/Email)
* [PaymentMethodId](/sdks/cdp-sdks-v2/typescript/PaymentMethods/PaymentMethodId)
* [PaymentMethodsPaymentMethod](/sdks/cdp-sdks-v2/typescript/PaymentMethods/PaymentMethodsPaymentMethod)