crate::transaction::history::controller::openapi::transactions

GET /v1/customers/{customer_id}/transactions/{transaction_id}

Changed on

Request

Path parameters

customer_idstring required

Customer ID

transaction_idstring required

Transaction ID

Response

Successfully retrieved transaction

customer_idstring required

Portfolio ID — also exposed as customer_id in OpenAPI. Identifies one individual application / portfolio row within an entity.

account_idstring nullable
recipient_idstring nullable

Recipient ID for third-party payouts. Present only when this transaction targets a recipient (cpid is non-empty); absent for self-withdrawals and non-withdrawal transactions.

transaction_idstring required

Unique transaction identifier

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

transaction_action'DEPOSIT' | 'WITHDRAWAL' | 'CONVERSION' | 'AUTO_CONVERSION' | 'TRANSFER' | 'REWARD' required
transaction_direction'FIAT_IN' | 'FIAT_OUT' | 'CRYPTO_IN' | 'CRYPTO_OUT' | 'BUY' | 'SELL' | 'CONVERT' | 'AUTO_CONVERSION' | 'TRANSFER_IN' | 'TRANSFER_OUT' | 'REWARD_IN' | 'REWARD_OUT' required
amountstring required

Transaction amount

assetstring
  • Stablecoin assets: USDC, USDT, PYUSD, RLUSD, USDG, USDP, EURC, MXNB, 1USD(1USD/USDC conversion only, deposit/withdrawal not supported)
  • Digital assets: BTC, ETH, SOL
  • Fiat currencies: USD, MXN
networkstring

Public network identifier for bank, blockchain and internal transactions.

Allowed values:

  • Bank: US_ACH, US_FEDWIRE, US_RTP, US_FEDNOW, SWIFT, CUBIX, SPEI, PIX_TRANSFER, LOCAL_BANK_TRANSFER, CHATS, FPS, SEPA, FASTER_PAYMENT, UAEFTS, UPI, EREBOR_RAIL
  • Blockchain: ETHEREUM, POLYGON, ARBITRUM, AVALANCHE, BASE, BNBCHAIN, SOLANA, TRON, ONE_MONEY, BITCOIN
  • Internal: INTERNAL

Availability depends on the asset and customer account configuration.

status'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'RETURNED' | 'MICRO_DEPOSIT' | 'MICRO_DEPOSIT_REVERSED' required
amount_type'SEND_AMOUNT' | 'RECEIVE_AMOUNT'
purpose_codestring nullable

Purpose code for a fiat withdrawal.

memorandumstring nullable

A string representing the message about the transaction.

created_atstring required
modified_atstring required

Example response

{
  "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
  "account_id": "BZ-A2C4-9XPN",
  "recipient_id": "f77a8df1-a2b3-4c5d-9e8f-1234567890ab",
  "transaction_id": "aac5201f-7f1c-11f0-b018-de09fc637374",
  "amount": "500",
  "asset": "USDC",
  "network": "ETHEREUM",
  "transaction_fee": {
    "value": "10.55",
    "asset": "USDC"
  },
  "platform_fee": {
    "value": "10.55",
    "asset": "USDC"
  },
  "partner_fee": {
    "value": "10.55",
    "asset": "USDC"
  },
  "source": {
    "wallet_address": "0x71a6c6be0be5f28ef4ea7541749d90d9c66fec7d",
    "external_account_id": "2e92e758-893e-11f0-b308-2eaa4f6974f2",
    "amount": "500",
    "asset": "USDC",
    "network": "ETHEREUM",
    "bank_name": "HSBC Bank USA, N.A.",
    "bank_account_name": "TechStart Holdings LLC"
  },
  "destination": {
    "wallet_address": "0x71a6c6be0be5f28ef4ea7541749d90d9c66fec7d",
    "external_account_id": "2e92e758-893e-11f0-b308-2eaa4f6974f2",
    "amount": "489.45",
    "asset": "USDC",
    "network": "ETHEREUM",
    "bank_name": "JPMorgan Chase Bank, N.A.",
    "bank_account_name": "TechStart Holdings LLC",
    "reference": "6471f23f-6b54-42e4-a2f3-febef7caac18"
  },
  "receiving_virtual_account": {
    "virtual_account_id": "VA-7K3M-9X2R"
  },
  "action_required": {
    "type": "RFI",
    "case_id": "TC-WXYZ-2345",
    "action": "SUBMIT_INFORMATION"
  },
  "memorandum": "first transaction",
  "created_at": "2025-08-21T07:56:57.981Z",
  "modified_at": "2025-08-21T07:56:57.981Z",
  "sub_transactions": [
    {
      "customer_id": "14f20ebd-893b-11f0-b308-2eaa4f6974f2",
      "account_id": "BZ-A2C4-9XPN",
      "recipient_id": "f77a8df1-a2b3-4c5d-9e8f-1234567890ab",
      "transaction_id": "aac5201f-7f1c-11f0-b018-de09fc637374",
      "amount": "500",
      "asset": "USDC",
      "network": "ETHEREUM",
      "transaction_fee": {
        "value": "10.55",
        "asset": "USDC"
      },
      "platform_fee": {
        "value": "10.55",
        "asset": "USDC"
      },
      "partner_fee": {
        "value": "10.55",
        "asset": "USDC"
      },
      "source": {
        "wallet_address": "0x71a6c6be0be5f28ef4ea7541749d90d9c66fec7d",
        "external_account_id": "2e92e758-893e-11f0-b308-2eaa4f6974f2",
        "amount": "500",
        "asset": "USDC",
        "network": "ETHEREUM",
        "bank_name": "HSBC Bank USA, N.A.",
        "bank_account_name": "TechStart Holdings LLC"
      },
      "destination": {
        "wallet_address": "0x71a6c6be0be5f28ef4ea7541749d90d9c66fec7d",
        "external_account_id": "2e92e758-893e-11f0-b308-2eaa4f6974f2",
        "amount": "489.45",
        "asset": "USDC",
        "network": "ETHEREUM",
        "bank_name": "JPMorgan Chase Bank, N.A.",
        "bank_account_name": "TechStart Holdings LLC",
        "reference": "6471f23f-6b54-42e4-a2f3-febef7caac18"
      },
      "receiving_virtual_account": {
        "virtual_account_id": "VA-7K3M-9X2R"
      },
      "action_required": {
        "type": "RFI",
        "case_id": "TC-WXYZ-2345",
        "action": "SUBMIT_INFORMATION"
      },
      "memorandum": "first transaction",
      "created_at": "2025-08-21T07:56:57.981Z",
      "modified_at": "2025-08-21T07:56:57.981Z"
    }
  ]
}

Changes

    • warning

      added the new MICRO_DEPOSIT enum value to the //// response property for the response status

    • warning

      added the new MICRO_DEPOSIT enum value to the /////// response property for the response status

    • warning

      added the new MICRO_DEPOSIT_REVERSED enum value to the //// response property for the response status

    • warning

      added the new MICRO_DEPOSIT_REVERSED enum value to the /////// response property for the response status

    • info

      api tag crate::transaction::history::controller::openapi::transactions added

    • info

      api tag Transactions removed

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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