> ## 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

## Namespaces

* [TransferRequest](/sdks/cdp-sdks-v2/typescript/Transfers/namespaces/TransferRequest/index)

## Interfaces

### DepositTravelRuleRequest

Defined in: [\_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts:28](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts#L28)

#### Example

```ts theme={null}
{
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    transferId: "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    originator: {
        name: "John Doe",
        address: {
            line1: "123 Main St",
            city: "San Francisco",
            state: "CA",
            postCode: "94105",
            countryCode: "US"
        }
    },
    beneficiary: {
        name: "Jane Smith"
    },
    isSelf: false
}
```

#### Properties

##### beneficiary?

```ts theme={null}
optional beneficiary: DepositTravelRuleBeneficiary;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts:40](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts#L40)

Beneficiary information for the travel rule submission.

##### idempotencyKey?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts:36](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts#L36)

An optional string request header for making requests safely retryable.
When included, duplicate requests with the same key will return identical responses.
Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.

##### isSelf?

```ts theme={null}
optional isSelf: boolean;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts:42](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts#L42)

Indicates whether the user attests that the originating wallet belongs to them.

##### originator?

```ts theme={null}
optional originator: DepositTravelRuleOriginator;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts:38](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/DepositTravelRuleRequest.ts#L38)

Originator information for the travel rule submission.

##### transferId

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

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

The unique identifier of the transfer.

***

### ExecuteFundTransferRequest

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

#### Example

```ts theme={null}
{
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    transferId: "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}
```

#### Properties

##### idempotencyKey?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ExecuteFundTransferRequest.ts:20](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ExecuteFundTransferRequest.ts#L20)

An optional string request header for making requests safely retryable.
When included, duplicate requests with the same key will return identical responses.
Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.

##### transferId

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

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

The ID of the transfer.

***

### GetTransferByIdRequest

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

#### Example

```ts theme={null}
{
    transferId: "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}
```

#### Properties

##### transferId

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

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

The unique identifier of the transfer.

***

### ListTransfersRequest

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:26](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L26)

#### Example

```ts theme={null}
{
    accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    sourceAccountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    targetAccountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    createdAfter: "2026-01-01T00:00:00Z",
    createdBefore: "2026-01-31T23:59:59Z",
    updatedAfter: "2026-01-01T00:00:00Z",
    updatedBefore: "2026-01-31T23:59:59Z",
    sourceAsset: "usd",
    targetAsset: "usdc",
    sourceAddress: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    targetAddress: "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    targetEmail: "user@example.com",
    transferId: "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    pageToken: "eyJsYXN0X2lkIjogImFiYzEyMyIsICJ0aW1lc3RhbXAiOiAxNzA3ODIzNzAxfQ=="
}
```

#### Properties

##### accountId?

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

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

Filter transfers by account ID. Returns transfers where the specified account is either the source or target (OR semantics). Cannot be combined with `sourceAccountId` or `targetAccountId`.

##### createdAfter?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:36](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L36)

Filter transfers to those created at or after this datetime (inclusive). ISO 8601 format.

##### createdBefore?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:38](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L38)

Filter transfers to those created at or before this datetime (inclusive). ISO 8601 format.

##### pageSize?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:56](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L56)

The number of resources to return per page.

##### pageToken?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:58](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L58)

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

##### sourceAccountId?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:32](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L32)

Filter transfers by source account ID. Returns only transfers where the specified account is the source. Cannot be combined with `accountId`.

##### sourceAddress?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:48](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L48)

Filter transfers by the on-chain address of the source.

##### sourceAsset?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:44](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L44)

Filter transfers by source asset symbol (e.g., `usd`, `usdc`).

##### status?

```ts theme={null}
optional status: TransferStatus;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:28](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L28)

Filter transfers by status. Useful for building dashboards, monitoring active transfers, or finding transfers needing action.

##### targetAccountId?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:34](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L34)

Filter transfers by target account ID. Returns only transfers where the specified account is the target. Cannot be combined with `accountId`.

##### targetAddress?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:50](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L50)

Filter transfers by the on-chain destination address of the target.

##### targetAsset?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:46](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L46)

Filter transfers by target asset symbol (e.g., `usdc`, `eth`).

##### targetEmail?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:52](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L52)

Filter transfers by the email address of the target recipient.

##### transferId?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:54](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L54)

Filter to a specific transfer by ID. When provided, returns only the matching transfer and bypasses pagination.

##### updatedAfter?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:40](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L40)

Filter transfers to those updated at or after this datetime (inclusive). ISO 8601 format. Useful for incremental sync — poll for transfers that changed state since your last check.

##### updatedBefore?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts:42](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/ListTransfersRequest.ts#L42)

Filter transfers to those updated at or before this datetime (inclusive). ISO 8601 format.

***

### ListTransfersResponse

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

#### Properties

##### nextPageToken?

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

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

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

##### transfers

```ts theme={null}
transfers: Transfer[];
```

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

The list of transfers.

***

### TransferRequest

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:62](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L62)

#### Example

```ts theme={null}
{
    idempotencyKey: "8e03978e-40d5-43e8-bc93-6894a57f9324",
    source: {
        accountId: "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
        asset: "usd"
    },
    target: {
        address: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
        network: "base",
        asset: "usdc"
    },
    amount: "100.00",
    asset: "usd",
    validateOnly: false,
    execute: false,
    metadata: {
        "invoiceId": "12345",
        "reference": "Payment for invoice #12345"
    },
    travelRule: {
        isSelf: false,
        isIntermediary: true,
        originator: {
            financialInstitution: "PayPal, Inc.",
            name: "John Doe",
            address: {
                line1: "123 Main St",
                line2: "Unit 201",
                city: "San Francisco",
                state: "California",
                postCode: "94105",
                countryCode: "US"
            },
            personalId: "123-45-6789",
            dateOfBirth: {
                day: "15",
                month: "08",
                year: "1990"
            }
        },
        beneficiary: {
            name: "Jane Smith",
            address: {
                line1: "456 Oak Ave",
                city: "Paris",
                postCode: "75001",
                countryCode: "FR"
            },
            walletType: "custodial"
        }
    }
}
```

#### Properties

##### amount

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

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:72](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L72)

The amount of the transfer, as a decimal string in standard unit denomination of the asset specified by `asset` (e.g., "100.00" for 100 USD, "0.05" for 0.05 ETH).

##### amountType?

```ts theme={null}
optional amountType: AmountType;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:81](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L81)

Specifies whether the given amount is to be received by the target or taken from the source.

* `target`: The transfer `target` receives the exact value specified in `amount`. Fees are added to the amount taken from the transfer `source`.
* `source`: The transfer `target` receives the value specified in `amount`, minus any fees.

##### asset

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

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:74](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L74)

The symbol of the asset for the amount. This must be one of the assets of the source or target.

##### execute

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

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:85](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L85)

Whether to immediately execute the transfer. If false, the transfer will be created in quoted status and must be executed manually via the /execute endpoint.

##### idempotencyKey?

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

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:68](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L68)

An optional string request header for making requests safely retryable.
When included, duplicate requests with the same key will return identical responses.
Refer to our [Idempotency docs](https://docs.cdp.coinbase.com/api-reference/v2/idempotency) for more information on using idempotency keys.

##### metadata?

```ts theme={null}
optional metadata: Metadata;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:86](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L86)

##### source

```ts theme={null}
source: CreateTransferSource;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:69](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L69)

##### target

```ts theme={null}
target: TransferTarget;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:70](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L70)

##### travelRule?

```ts theme={null}
optional travelRule: TravelRule;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:88](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L88)

Travel Rule compliance information for this transfer. Required for transfers to external wallets above regulatory thresholds. Fields required differ by region and Coinbase contracting entity.

##### validateOnly?

```ts theme={null}
optional validateOnly: boolean;
```

Defined in: [\_vendor/api/resources/transfers/client/requests/TransferRequest.ts:83](https://github.com/coinbase/cdp-sdk/blob/30d1b3dc350cd763fecf481c5bc976bd77951f3b/typescript/packages/cdp-sdk/src/_vendor/api/resources/transfers/client/requests/TransferRequest.ts#L83)

If true, validates the transfer without initiating it.  If the request is valid, a 2xx will be returned. If the request is invalid, a 4xx error will be returned. The response will include an errorType, for e.g. invalid\_target if the specified target cannot receive funds.

## Namespaces

* [TransferDetails](/sdks/cdp-sdks-v2/typescript/Transfers/namespaces/TransferDetails/index)
* [TransferFee](/sdks/cdp-sdks-v2/typescript/Transfers/namespaces/TransferFee/index)
* [TravelRuleBeneficiary](/sdks/cdp-sdks-v2/typescript/Transfers/namespaces/TravelRuleBeneficiary/index)
* [TravelRuleOriginator](/sdks/cdp-sdks-v2/typescript/Transfers/namespaces/TravelRuleOriginator/index)

## Interfaces

### DateOfBirth

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

Date of birth.

#### Properties

##### day?

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

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

Day of birth (01-31).

##### month?

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

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

Month of birth (01-12).

##### year?

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

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

Year of birth (four digits).

***

### OnchainAddress

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

The target of the payment is an onchain address.

#### Properties

##### address

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

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

The onchain crypto address of the recipient.

Examples:

* EVM address: 0xabc1234567890abcdef1234567890abcdef123456
* Solana address: HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT
* XRP address: rhccc5p23aKiCGFcEqqnjEfLRZ6xEvfy3s

##### asset

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

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

Asset symbol of the payment received by the recipient.

##### destinationTag?

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

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

The destination tag of the onchain address. Destination tags are used by certain networks
(primarily XRP/Ripple) to identify specific recipients when multiple users share a single address.
The tag ensures funds are credited to the correct account within the shared address.

Examples by network:

* XRP/Ripple: Numeric values like "1234567890" or "123456"
* Stellar (XLM): Memos which can be text, ID, or hash format

Note: Most networks (Ethereum, Bitcoin, Solana) do not use destination tags.

##### network

```ts theme={null}
network: Network;
```

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

***

### PhysicalAddress

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

A physical address with standard address components including street, city, state/province, postal code, and country.

#### Properties

##### city?

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

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

City or locality.

##### countryCode?

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

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

ISO 3166-1 alpha-2 country code (2 characters). See [https://en.wikipedia.org/wiki/List\_of\_ISO\_3166\_country\_codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).

##### line1?

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

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

Primary street address.

##### line2?

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

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

Secondary address information.

##### postCode?

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

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

Postal or ZIP code.

##### state?

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

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

State, province, or region.

***

### Transfer

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

A Transfer represents all the information needed to execute a transfer and tracks the lifecycle of a transfer from initiation through completion or failure.

#### Properties

##### completedAt?

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

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

The date and time the transfer was completed.

##### createdAt?

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

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

The date and time the transfer was created. Required when validateOnly is false.

##### details?

```ts theme={null}
optional details: TransferDetails;
```

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

##### estimate?

```ts theme={null}
optional estimate: TransferEstimate;
```

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

##### exchangeRate?

```ts theme={null}
optional exchangeRate: TransferExchangeRate;
```

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

Exchange rate information for currency conversion. The rate indicates how much of the target asset is equivalent to one unit of the source asset. May be omitted in the `quoted` state if the rate cannot be guaranteed; see `estimate.exchangeRate` for the expected rate. Populated with the actual executed rate once the transfer completes.

##### executedAt?

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

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

The date and time the transfer was executed and moved to processing. Only present when status has progressed beyond `quoted`.

##### expiresAt?

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

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

The date and time when this transfer will expire if not executed. Only present for `quoted` status. A new transfer must be created to obtain an updated quote after expiration. Required when validateOnly is false.

##### failureReason?

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

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

The reason for failure, if the transfer failed. Only present when status is `failed`.

##### fees?

```ts theme={null}
optional fees: TransferFees;
```

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

The fees associated with this transfer. Different transfer types have different fee structures. May be omitted in the `quoted` state if the fees cannot be guaranteed; see `estimate.fees` for the expected fees. Populated with the actual fees once the transfer completes.

##### metadata?

```ts theme={null}
optional metadata: Metadata;
```

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

##### source

```ts theme={null}
source: TransferSource;
```

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

##### sourceAmount?

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

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

The amount of the source asset that will be transferred out, as a decimal string in standard unit denomination.

##### sourceAsset?

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

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

The asset symbol of the source amount.

##### status?

```ts theme={null}
optional status: TransferStatus;
```

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

##### target

```ts theme={null}
target: TransferTarget;
```

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

##### targetAmount?

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

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

The amount of the target asset received, as a decimal string in standard unit denomination. May be omitted in the `quoted` state if the value cannot be guaranteed; see `estimate.targetAmount` for the expected value. Populated with the actual executed amount once the transfer completes.

##### targetAsset?

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

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

The asset symbol of the target amount.

##### transferId?

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

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

The ID of the transfer. Required when validateOnly is false.

##### updatedAt?

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

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

The date and time the transfer was last updated. Required when validateOnly is false.

***

### TransferDetails

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

Additional details about the transfer. For example, if the transfer was sent to a deposit destination, the information about that destination will be included in this field.

#### Properties

##### depositDestination?

```ts theme={null}
optional depositDestination: DepositDestinationReference;
```

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

##### onchainTransactions?

```ts theme={null}
optional onchainTransactions: Item[];
```

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

The onchain transactions associated with the transfer.

##### travelRule?

```ts theme={null}
optional travelRule: TravelRule;
```

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

Travel rule compliance status for deposit transfers. Present when the transfer requires travel rule information.

***

### TransferEstimate

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

Captures estimated values for transfers where amounts can't be guaranteed (e.g., USDC -> EURC).

The values in `estimate` are not modified after a transfer is executed. They are preserved as an immutable record of the original pre-execution snapshot.

The actual executed values are populated in the `transfer` resource post-execution.

#### Properties

##### estimatedAt

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

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

The date and time when this estimate was captured.

##### exchangeRate?

```ts theme={null}
optional exchangeRate: TransferExchangeRate;
```

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

The estimated exchange rate at the time this estimate was captured.

##### fees?

```ts theme={null}
optional fees: TransferFees;
```

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

The estimated fees at the time this estimate was captured.

##### targetAmount?

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

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

Estimated amount of the target asset that will be received, as a decimal string in standard unit denomination.

##### targetAsset?

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

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

The asset symbol of the estimated target amount.

***

### TransferExchangeRate

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

Exchange rate information for currency conversion. The rate indicates how much of the target asset is equivalent to one unit of the source asset.

#### Properties

##### rate

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

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

The exchange rate value as a decimal string. Indicates how many units of the target asset equal one unit of the source asset.

##### sourceAsset

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

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

The asset being converted from.

##### targetAsset

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

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

The asset being converted to.

***

### TransferFee

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

A single fee for a transfer.

#### Properties

##### amount

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

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

The amount of the fee in units of the asset specified by `asset`.

##### asset

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

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

The asset symbol.

##### type

```ts theme={null}
type: Type;
```

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

The type of the fee, indicating its purpose.

***

### TransfersAccount

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

The Account specific details for the transfer.

#### Properties

##### accountId

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

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

The ID of the Account.

##### asset

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

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

***

### TravelRule

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

Required Travel Rule fields differ by region. These requirements are determined based on which Coinbase entity the customer has signed the service agreement for.

#### Properties

##### beneficiary?

```ts theme={null}
optional beneficiary: TravelRuleBeneficiary;
```

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

##### isIntermediary?

```ts theme={null}
optional isIntermediary: boolean;
```

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

Indicates whether Coinbase is being used as an intermediary Virtual Asset Service Provider (VASP) to send crypto on behalf of your customer.

**Background:**

The Travel Rule (FATF Recommendation 16) requires VASPs to share originator and beneficiary information for virtual asset transfers. When Coinbase acts as an intermediary, additional Travel Rule data must be provided to satisfy compliance requirements.

**Set to `true` when:**

* Your organization is a VASP using Coinbase to send crypto **on behalf of your end customer**
* In this scenario, Coinbase acts as an intermediary in the transfer chain and handles Travel Rule data exchange with the beneficiary VASP

**Set to `false` (or omit) when:**

* You are transferring funds directly from your own Coinbase account, where **Coinbase is your primary VASP** rather than an intermediary for another institution

**Impact on required fields:**

When `isIntermediary` is `true`, you must provide the `originator` object with details about the **original sender**, including:

* Originator name
* Originator address
* Your VASP information (`virtualAssetServiceProvider` object with `name`, `address`, and `identifier`)

For jurisdictions that require them (such as Coinbase Luxembourg), `personalIdentification` and `dateOfBirth` must also reflect the **original sender's** identity — not the intermediary's. These fields will not be auto-populated from any internal KYC data when `isIntermediary` is `true`.

##### isSelf?

```ts theme={null}
optional isSelf: boolean;
```

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

Indicates whether the user attests that the receiving wallet belongs to them.

##### originator?

```ts theme={null}
optional originator: TravelRuleOriginator;
```

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

***

### TravelRuleBeneficiary

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

Beneficiary (receiver) party.

#### Properties

##### address?

```ts theme={null}
optional address: PhysicalAddress;
```

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

##### financialInstitution?

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

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

Name of the financial institution.

##### name?

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

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

Full name of the party.

##### walletType?

```ts theme={null}
optional walletType: WalletType;
```

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

The type of the beneficiary's wallet.

***

### TravelRuleOriginator

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

Originator (sender) party.

#### Properties

##### address?

```ts theme={null}
optional address: PhysicalAddress;
```

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

##### dateOfBirth?

```ts theme={null}
optional dateOfBirth: DateOfBirth;
```

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

Date of birth of the originator. Required by certain jurisdictions (such as Coinbase Luxembourg) to satisfy Travel Rule reporting obligations.

##### financialInstitution?

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

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

Name of the financial institution.

##### name?

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

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

Full name of the party.

##### personalId?

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

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

Personal identifier for travel rule compliance. For individuals: passport number, national ID, or driver's license. For institutions: LEI (Legal Entity Identifier).

##### virtualAssetServiceProvider?

```ts theme={null}
optional virtualAssetServiceProvider: VirtualAssetServiceProvider;
```

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

Information about the originating Virtual Asset Service Provider (VASP) that handles cryptocurrency or other virtual assets on behalf of customers.

## Type Aliases

* [BlockchainAddress](/sdks/cdp-sdks-v2/typescript/Transfers/BlockchainAddress)
* [CreateTransferSource](/sdks/cdp-sdks-v2/typescript/Transfers/CreateTransferSource)
* [Metadata](/sdks/cdp-sdks-v2/typescript/Transfers/Metadata)
* [Network](/sdks/cdp-sdks-v2/typescript/Transfers/Network)
* [TransferFees](/sdks/cdp-sdks-v2/typescript/Transfers/TransferFees)
* [TransferSource](/sdks/cdp-sdks-v2/typescript/Transfers/TransferSource)
* [TransferStatus](/sdks/cdp-sdks-v2/typescript/Transfers/TransferStatus)
* [TransferTarget](/sdks/cdp-sdks-v2/typescript/Transfers/TransferTarget)
* [TravelRuleStatus](/sdks/cdp-sdks-v2/typescript/Transfers/TravelRuleStatus)

## Variables

* [Network](/sdks/cdp-sdks-v2/typescript/Transfers/Network-1)
* [TransferStatus](/sdks/cdp-sdks-v2/typescript/Transfers/TransferStatus-1)
* [TravelRuleStatus](/sdks/cdp-sdks-v2/typescript/Transfers/TravelRuleStatus-1)