v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Transactions

Get Transaction

Retrieve a specific transaction by ID for a customer.

Transaction Types

DEPOSIT: Fiat or crypto deposit
WITHDRAWAL: Fiat or crypto withdrawal
CONVERSION: Asset conversion (buy/sell/convert)
AUTO_CONVERSION: Auto-conversion rule execution
TRANSFER: Internal transfer between customers

TRANSFER Response For TRANSFER transactions:

transaction_action: TRANSFER
amount / asset: Transfer amount and asset
No transaction fee (transfers are fee-free)
Both sender and receiver can query their respective transaction records

AUTO_CONVERSION Response For AUTO_CONVERSION transactions, the response includes:

Main transaction metadata (ID, status, source/destination assets)
sub_transactions array with individual steps:
transaction_id: Sub-transaction ID
transaction_action: DEPOSIT | CONVERSION | WITHDRAWAL
status: Current status of the sub-transaction
amount / asset: Transaction amount and asset
to_amount / to_asset: Target amount and asset (for conversion)
created_at: Timestamp

Note: For SWIFT withdrawals, UETR is populated in the reference field.

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

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.

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
Fiat currencies: USD

networkstring

status'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'RETURNED' required

amount_type'SEND_AMOUNT' | 'RECEIVE_AMOUNT'

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"
  },
  "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"
      },
      "memorandum": "first transaction",
      "created_at": "2025-08-21T07:56:57.981Z",
      "modified_at": "2025-08-21T07:56:57.981Z"
    }
  ]
}