Sign in
Transfers

Get transfer

Changed on

Get a transfer by its ID.

get/v2/transfers/{transferId}

Request

  • Base URL: https://api.cdp.coinbase.com/platform
  • URL: https://api.cdp.coinbase.com/platform/v2/transfers/{transferId}
  • Auth: HTTP bearer

Path parameters

transferIdstring required
Example:transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114

The unique identifier of the transfer.

Response

Successfully got transfer.

transferIdstring

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

status'quoted' | 'processing' | 'completed' | 'failed'

The current status of the transfer, indicating what action you need to take next. Required when validateOnly is false.

sourceAmountstring

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

sourceAssetstring

The symbol of the asset (e.g., eth, usd, usdc, usdt).

targetAmountstring

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.

targetAssetstring

The symbol of the asset (e.g., eth, usd, usdc, usdt).

completedAtstring date-time

The date and time the transfer was completed.

failureReasonstring

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

expiresAtstring date-time

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.

executedAtstring date-time

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

createdAtstring date-time

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

updatedAtstring date-time

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

metadataMetadata

Optional metadata as key-value pairs. Use this to store additional structured information on a resource, such as customer IDs, order references, or any application-specific data. Up to 10 key/value pairs may be provided. Keys and values are both strings. Keys must be ≤ 40 characters; values must be ≤ 500 characters.

Example response

{
  "transferId": "transfer_af2937b0-9846-4fe7-bfe9-ccc22d935114",
  "status": "completed",
  "source": {
    "accountId": "account_af2937b0-9846-4fe7-bfe9-ccc22d935114",
    "asset": "usd"
  },
  "target": {
    "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "network": "base",
    "asset": "usdc"
  },
  "sourceAmount": "103.50",
  "sourceAsset": "usd",
  "targetAmount": "100.00",
  "targetAsset": "usdc",
  "completedAt": "2025-01-01T00:05:00Z",
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:05:00Z"
}

Changes

  • 156440e9f8dfRevision changes
    • warning

      added the new incompatible_event_types enum value to the response property for the response status

    • warning

      added the new invalid_webhook_headers enum value to the response property for the response status

    • warning

      added the new invalid_webhook_url enum value to the response property for the response status

    • warning

      added the new mandate_action_pending enum value to the response property for the response status

    • warning

      added the new mandate_canceled enum value to the response property for the response status

    • warning

      added the new mandate_expired enum value to the response property for the response status

    • warning

      added the new mandate_invalid_status enum value to the response property for the response status

    • warning

      added the new mandate_policy_violation enum value to the response property for the response status

    • warning

      added the new mandate_revoked enum value to the response property for the response status

    • warning

      added the new subscription_limit_exceeded enum value to the response property for the response status

    • info

      added the non-success response with the status

  • 229ed860a74bRevision changes
    • warning

      added the new mfa_challenge_not_found enum value to the response property for the response status

    • warning

      added the new operation_in_progress enum value to the response property for the response status