Sign in
Customers

Get customer transfers

Retrieve all transfers for a specific customer (as source or destination)

get/v1/customers/{customerId}/transfers

Path parameters

customerIdstring required
Example:cus_abc123

Customer ID

Query parameters

limitnumber

Number of results to return (1-1000). Use with offset for traditional pagination.

offsetnumber

Number of results to skip. Use with limit for traditional pagination.

page_sizenumber

Number of results per page (1-1000). Use with starting_after for cursor-based pagination.

starting_afterstring

Cursor for pagination. Use the ID of the last item from the previous page to get the next page. Use with page_size for cursor-based pagination.

idstring

Filter by transfer ID prefix (e.g. tfr_abc123)

sourceCustomerIdstring

Filter by source customer ID

accountIdstring
counterpartyIdstring

Filter by counterparty ID

agentIdstring
Example:agt_abc123

Filter by the agent whose key created or submitted the transfer

clientReferenceIdstring
Example:order_abc123

Filter by the clientReferenceId supplied at transfer creation. Exact match. Not enforced unique — multiple transfers can share a value, so treat the result as a list.

flow'CRYPTO_TO_CRYPTO' | 'CRYPTO_TO_FIAT' | 'FIAT_TO_CRYPTO' | 'FIAT_TO_FIAT' | 'FIAT_TO_CRYPTO_TO_FIAT' | 'FX' | 'INTERNAL' | 'FEE_CRYPTO' | 'REFUND_CRYPTO' | 'REFUND_FIAT'
status'DRAFT' | 'PENDING_AUTHORIZATION' | 'IN_REVIEW' | 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'REVERSED'

Filter by transfer status. Transfers that fail after funds are received are treated as IN_REVIEW and excluded from FAILED.

startDatestring
endDatestring
expandstring[]

Fields to expand in the response. Pass as comma-separated values or repeated query params.

[
  "counterparty"
]

Headers

X-API-Keystring

API key

Response

Paginated list of customer transfers

has_moreboolean

Whether there are more results available

page_sizenumber

Number of results per page

urlstring

URL for this request

page_nextstring nullable

URL to fetch the next page of results

page_prevstring nullable

URL to fetch the previous page of results

Example response

{
  "data": [
    {
      "id": "tfr_1234567890abcdef",
      "organizationId": "org_abc123",
      "clientReferenceId": "order_abc123",
      "sourceCustomerId": "cus_abc123",
      "counterpartyId": "cp_abc123",
      "agentId": "agt_abc123",
      "flow": "CRYPTO_TO_FIAT",
      "status": "COMPLETED",
      "source": {
        "currency": "usd",
        "fundingCurrency": "usdc",
        "paymentRail": "ACH",
        "direction": "CREDIT",
        "accountId": "vba_abc123",
        "accountType": "VIRTUAL_BANK",
        "externalAccountId": "ext_bank_456",
        "fromAddress": "0x1234567890abcdef1234567890abcdef12345678",
        "refundAccountId": "inw_abc123",
        "accountName": "Acme Corporation",
        "originator": {
          "name": "Acme Suppliers LLC",
          "bankName": "Example National Bank",
          "routingNumber": "021000021",
          "accountNumber": "987654321",
          "swiftBic": "CHASUS33",
          "bankCountry": "US"
        }
      },
      "destination": {
        "currency": "USDC",
        "paymentRail": "ETHEREUM",
        "accountId": "vwa_def456",
        "accountType": "EXTERNAL_BANK",
        "externalAccountId": "ext_bank_789",
        "toAddress": "0x1234567890abcdef1234567890abcdef12345678",
        "accountName": "Acme Corporation",
        "bankName": "JPMorgan Chase Bank",
        "bankCountryCode": "US",
        "wireMessage": "Payment for invoice INV-2026-001",
        "achReference": "ORDER123",
        "swiftReference": "Payment for invoice INV-2026-001",
        "rtpReference": "Payment for invoice INV-2026-001",
        "payoutReference": "INV2026"
      },
      "sourceAmount": {
        "currency": "USD",
        "exponent": 2,
        "value": "12345",
        "displayValue": "123.45"
      },
      "destinationAmount": {
        "currency": "USD",
        "exponent": 2,
        "value": "12345",
        "displayValue": "123.45"
      },
      "refund": {
        "status": "COMPLETED",
        "reason": "Fees exceed deposit amount",
        "amount": {
          "currency": "USD",
          "exponent": 2,
          "value": "12345",
          "displayValue": "123.45"
        },
        "address": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
        "txHash": "0x1234567890abcdef..."
      },
      "quoteId": "quote_abc123",
      "exchangeRate": "0.99985",
      "referenceRate": "1.158691536019208779",
      "referenceRateAsOf": "2026-09-02T18:30:04.000Z",
      "referenceProvider": "XE",
      "developerFeeFixed": "100",
      "developerFeePercent": 0.005,
      "developerFee": {
        "amount": {
          "currency": "USD",
          "exponent": 2,
          "value": "12345",
          "displayValue": "123.45"
        },
        "fixed": "100",
        "percent": 0.005,
        "txHash": "0x1234567890abcdef..."
      },
      "depositInstructions": {
        "type": "crypto",
        "paymentRail": "ETHEREUM",
        "toAddress": "0x1234567890abcdef1234567890abcdef12345678",
        "amount": {
          "currency": "USD",
          "exponent": 2,
          "value": "12345",
          "displayValue": "123.45"
        },
        "accountId": "acc_abc123"
      },
      "createdAt": "2026-09-15T10:00:00.000Z",
      "updatedAt": "2026-09-15T10:00:00.000Z",
      "legs": [
        {
          "id": "tleg_abc123",
          "type": "DEPOSIT_CRYPTO",
          "inputCurrency": "USDC",
          "outputCurrency": "USD",
          "inputRail": "ETHEREUM",
          "outputRail": "ACH",
          "status": "PENDING",
          "uetr": "9b6f37f2-21f0-4b2b-b03c-1893364782ce",
          "imad": "20260309EREBBANK000002",
          "omad": "20260309MMQFMP0B012345",
          "achTraceNumber": "021000021234567",
          "txHash": "0x1234567890abcdef...",
          "developerFee": {
            "currency": "USD",
            "exponent": 2,
            "value": "12345",
            "displayValue": "123.45"
          },
          "feeTxHash": "0x1234567890abcdef..."
        }
      ],
      "remarks": "Partial payment - remaining balance to be paid next month",
      "uetr": "9b6f37f2-21f0-4b2b-b03c-1893364782ce",
      "imad": "20260309EREBBANK000002",
      "omad": "20260309MMQFMP0B012345",
      "achTraceNumber": "021000021234567",
      "txHash": "0x1234567890abcdef...",
      "systemRemark": "Tracking is unavailable for this SWIFT transfer. We will auto-complete it after 24 hours and mark it with an asterisk because settlement is assumed rather than confirmed.",
      "metadata": {
        "swiftRouting": {
          "source": "GPI_ROUTE",
          "senderBic": "CHASUS33",
          "receiverBic": "CLRBGB22",
          "checkedAt": "2026-05-10T16:34:42.597Z",
          "steps": [
            {
              "label": "Sender bank",
              "bic": "CHASUS33",
              "bankName": "JP Morgan Chase",
              "status": "Confirmed Active"
            }
          ]
        }
      },
      "estimatedSettlementAt": "2026-05-26T13:00:00.000Z",
      "nextCutoffAt": "2026-05-19T19:00:00.000Z",
      "cutoffTimezone": "America/New_York",
      "counterparty": {
        "id": "cp_abc123",
        "name": "Jane Doe",
        "beneficiaryType": "INDIVIDUAL",
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Apt 4B",
          "city": "San Francisco",
          "state": "CA",
          "postalCode": "94102",
          "country": "US",
          "transliterated": {
            "addressLine1": "123 Main Street",
            "addressLine2": "Apt 4B",
            "city": "Beijing",
            "state": "Hebei"
          }
        }
      }
    }
  ]
}

Changes

Changed in 5 of the 19 revisions of this API.9

  • da62fa03793e4See the full diff
    • ○

      added the new optional query request parameter agentId

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added

  • b83888a376d81See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 03a24c5c95252See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 382abbca8b011See the full diff
    • ○

      added the optional property //////////// to the response with the status

      response-optional-property-added

  • bca54100a6371See the full diff
    • ○

      added the optional property /////// to the response with the status

      response-optional-property-added