Types

{
    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
}

optional beneficiary: DepositTravelRuleBeneficiary;

optional idempotencyKey: string;

optional isSelf: boolean;

optional originator: DepositTravelRuleOriginator;

transferId: string;

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

optional idempotencyKey: string;

transferId: string;

{
    transferId: "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114"
}

transferId: string;

{
    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=="
}

optional accountId: string;

optional createdAfter: string;

optional createdBefore: string;

optional pageSize: number;

optional pageToken: string;

optional sourceAccountId: string;

optional sourceAddress: string;

optional sourceAsset: string;

optional status: TransferStatus;

optional targetAccountId: string;

optional targetAddress: string;

optional targetAsset: string;

optional targetEmail: string;

optional transferId: string;

optional updatedAfter: string;

optional updatedBefore: string;

optional nextPageToken: string;

transfers: Transfer[];

{
    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"
        }
    }
}

amount: string;

optional amountType: AmountType;

asset: string;

execute: boolean;

optional idempotencyKey: string;

optional metadata: Metadata;

source: CreateTransferSource;

target: TransferTarget;

optional travelRule: TravelRule;

optional validateOnly: boolean;

optional day: string;

optional month: string;

optional year: string;

address: string;

asset: string;

optional destinationTag: string;

network: Network;

optional city: string;

optional countryCode: string;

optional line1: string;

optional line2: string;

optional postCode: string;

optional state: string;

optional completedAt: string;

optional createdAt: string;

optional details: TransferDetails;

optional estimate: TransferEstimate;

optional exchangeRate: TransferExchangeRate;

optional executedAt: string;

optional expiresAt: string;

optional failureReason: string;

optional fees: TransferFees;

optional metadata: Metadata;

source: TransferSource;

optional sourceAmount: string;

optional sourceAsset: string;

optional status: TransferStatus;

target: TransferTarget;

optional targetAmount: string;

optional targetAsset: string;

optional transferId: string;

optional updatedAt: string;

optional depositDestination: DepositDestinationReference;

optional onchainTransactions: Item[];

optional travelRule: TravelRule;

estimatedAt: string;

optional exchangeRate: TransferExchangeRate;

optional fees: TransferFees;

optional targetAmount: string;

optional targetAsset: string;

rate: string;

sourceAsset: string;

targetAsset: string;

amount: string;

asset: string;

type: Type;

accountId: string;

asset: string;

optional beneficiary: TravelRuleBeneficiary;

optional isIntermediary: boolean;

optional isSelf: boolean;

optional originator: TravelRuleOriginator;

optional address: PhysicalAddress;

optional financialInstitution: string;

optional name: string;

optional walletType: WalletType;

optional address: PhysicalAddress;

optional dateOfBirth: DateOfBirth;

optional financialInstitution: string;

optional name: string;

optional personalId: string;

optional virtualAssetServiceProvider: VirtualAssetServiceProvider;