latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Payments

List transfers

Lists payment transfers for the authenticated organization or project scope.

get/v1/payments/transfers

Query parameters

walletstring

Filter by wallet walletId.

Example:privy_wallet_123

Filter by wallet walletId.

walletAddressstring

Filter by wallet address.

Example:7xKXtg2CW87d97TXJSDpbD5jBkheTqA83TZRuJosgAsU

Filter by wallet address.

searchstring

Search transfer ID, signature, provider reference, source or destination address, memo, counterparty ID, or counterparty display name. Use at least 3 non-whitespace characters; a blank value is treated as no search filter.

Example:xfr_example

tokenstring

Filter by token symbol or mint.

Example:USDC

Filter by token symbol or mint.

direction'inbound' | 'outbound'

Filter by transfer direction.

Example:outbound

Filter by transfer direction.

statusstring

Filter by transfer status. Accepts a comma-separated list of statuses.

Example:completed,confirmed,finalized

Filter by transfer status. Accepts a comma-separated list of statuses.

category'wallet' | 'ramp'

Filter by wallet transfers or ramp transfers.

Example:ramp

Filter by wallet transfers or ramp transfers.

typestring

Filter by one or more comma-separated transfer types.

Example:transfer,transfer_batch

Filter by one or more comma-separated transfer types.

counterpartyIdstring

Filter transfers tied to a specific counterparty.

Example:counterparty_example

Filter transfers tied to a specific counterparty.

Filter ramp transfers by provider.

Example:lightspark

Filter ramp transfers by provider.

providerReferencestring

Provider quote or transaction reference. Must be supplied with provider for exact ramp transfer lookup.

Example:Quote:019e979c-f660-5246-0000-c0588496b9ce

Provider quote or transaction reference. Must be supplied with provider for exact ramp transfer lookup.

fromstring date-time

Filter from timestamp.

Example:2025-01-01T00:00:00.000Z

Filter from timestamp.

tostring date-time

Filter to timestamp.

Example:2025-01-02T00:00:00.000Z

Filter to timestamp.

includeObserved'true' | 'false'

When filtering a wallet, include RPC-observed on-chain activity that has not been recorded by SDP. Disable for stable database-backed pagination.

sortBy'createdAt' | 'updatedAt' | 'amount' | 'status'

Field used to sort the transfer list.

Example:createdAt

Field used to sort the transfer list.

sortDirection'asc' | 'desc'

Sort direction.

Example:desc

Sort direction.

pageinteger

Page number (1-based).

Example:1

Page number (1-based).

pageSizeinteger

Items per page.

Example:20

Items per page.

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Transfer list

Example response

{
  "data": [
    {
      "id": "xfr_example",
      "organizationId": "org_example",
      "walletId": "privy_wallet_123",
      "projectId": "prj_example",
      "type": "transfer",
      "direction": "outbound",
      "status": "confirmed",
      "signature": "sig_example",
      "serializedTx": "base64_tx_example",
      "slot": 123456,
      "blockTime": "2025-01-01T00:00:00.000Z",
      "fee": 5000,
      "error": "Signature failed",
      "initiatedBy": {
        "type": "api_key"
      },
      "source": "So11111111111111111111111111111111111111112",
      "destination": "So11111111111111111111111111111111111111112",
      "rampsMemo": {
        "invoice": "INV-123",
        "po": "PO-9"
      },
      "amount": "100.00",
      "provider": "moonpay",
      "counterpartyId": "counterparty_example",
      "counterpartyDisplayName": "Acme Studio",
      "providerReference": "ramp_quote_example",
      "deliveryMode": "session_widget",
      "fiatCurrency": "USD",
      "fiatAmount": "100.00",
      "risk": {
        "provider": "trm",
        "score": "0.12",
        "level": "low",
        "evaluatedAt": "2025-01-01T00:00:00.000Z"
      },
      "moneygram": {
        "transactionId": "mgi_tx_example",
        "referenceNumber": "12345678",
        "payoutAmount": 25,
        "payoutStatus": "completed",
        "cryptoTransferId": "xfr_moneygram_crypto_leg_example",
        "solanaTxSignature": "sig_moneygram_usdc_transfer_example",
        "lastWidgetError": "Transaction cancelled by user"
      },
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-02T00:00:00.000Z"
    }
  ],
  "meta": {
    "requestId": "req_example"
  }
}