Transactions

Get customer transaction

Get status and details for a specific customer transaction.

GET
/api/v2/customers/{customerId}/transactions/{transactionId}

Returns details for a specific customer transaction. Use this to check the current status of a withdrawal or deposit. For deposit transactions where developerFee is present, wallet receive amount = targetAmount - developerFee.amount.

Status Values

  • PROCESSING — Transaction is being processed
  • PROPOSED — Awaiting approval in dashboard
  • PARTIALLY_SIGNED — If multiple approvers configured: requires more approvals.
  • COMPLETED — Successfully completed
  • FAILED — Transaction failed
  • CANCELLED — Cancelled by user
  • EXPIRED — Expired before completion
  • PENDING_REVERSAL — A return is in flight: a deposit being returned to the sender, before or after COMPLETED, or a withdrawal the recipient's bank returned that is being refunded. It always ends REVERSED.
  • REVERSED — Deposit returned to the sender's bank account, or withdrawal returned by the recipient's bank

Action Required

When requiresUiAction is true, the transaction needs user approval in the dashboard.

For AUD-only customers, each AUD payment is a DEPOSIT with paymentRail: "AU_BANK_TRANSFER", sourceCurrency: "AUD" and payerName; payments on hold are reported as PROCESSING. A returned AUD payment reports PENDING_REVERSAL while the return is in flight and REVERSED once it settles. An AUD withdrawal the recipient's bank returns, before or after COMPLETED, reports PENDING_REVERSAL while it is refunded, then REVERSED, refunded less the reversal fee (see reversal).

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key obtained on Settings > API Keys page in Compose UI.

In: header

Path Parameters

customerId*string

Unique identifier of the customer

transactionId*string

Unique identifier of the transaction

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET 'https://compose.finance/api/v2/customers/{customerId}/transactions/{transactionId}' \  -H 'Authorization: Bearer YOUR_API_KEY'

{
  "id": "txn_abc123",
  "type": "DEPOSIT",
  "status": "COMPLETED",
  "paymentRail": "SEPA",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "completedAt": "2024-01-15T10:35:00.000Z",
  "reference": "FLGVNY3H9F",
  "sourceCurrency": "EUR",
  "targetCurrency": "USDC",
  "sourceAmount": "1000",
  "targetAmount": "1167.95886",
  "exchangeRate": "1.1691279887",
  "fee": "1",
  "depositInstructions": {
    "accountType": "sharedAccount",
    "reference": "FLGVNY3H9F"
  },
  "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
  "developerFee": {
    "developerSpreadFeeBps": 100,
    "amount": "11.679589"
  },
  "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
}

{
  "error": "Unauthorized - Invalid or missing API key or session"
}
{
  "error": "Customers feature is not enabled for your organization"
}

{
  "error": "Customer not found"
}

{
  "error": "Rate limit exceeded. Please try again later."
}

{
  "error": "Internal server error"
}

Get an indicative rate quote GET

Preview the exchange rate, fees, and estimated amounts for a deposit or withdrawal before initiating the transaction. Rates are indicative and not locked — the actual rate is determined when the transaction is executed. Provide exactly one of `source_amount` or `target_amount`. Supported currencies: fiat (`EUR`, `USD`, `AUD`, `CAD`) and stablecoin (`USDC`, `EURC`, `USDT`), and the `AUDD` balance as a source. Supported pairs: `EUR`<->`USDC`, `EUR`<->`EURC`, `USD`<->`USDC`, `EURC`->`USD`, `USDT`->`EUR`, `USDT`->`USD` (EURC and USDT are withdrawal-only when USD is the target, from a custodial balance), `USDC`->`AUD`, `USDT`->`AUD`, `AUDD`->`AUD` (withdrawal-only, on `AU_BANK_TRANSFER`, when AUD functionality is enabled for your organization; not for a standard `customer_id`; `AUDD` also needs the AUDD balance enabled for your organization, otherwise `403`, and its rate is 1 unless a spread applies), and `CAD`->`USDC` (deposit-only, on `INTERAC`, when CAD deposits are enabled for your organization; otherwise `404`). For customer wallet deposits where `developer_fee` is present, the wallet receive amount is `target_amount - developer_fee.amount`.

Get customer transactions GET

Returns the transaction history for a specific customer. Only includes DEPOSIT and WITHDRAWAL transactions. For deposit transactions where `developerFee` is present, wallet receive amount = `targetAmount - developerFee.amount`. For AUD-only customers, each AUD payment is a `DEPOSIT` with `paymentRail: "AU_BANK_TRANSFER"`, `sourceCurrency: "AUD"` and `payerName`; payments on hold are reported as `PROCESSING`. A returned AUD payment reports `PENDING_REVERSAL` while the return is in flight and `REVERSED` once it settles. An AUD withdrawal the recipient's bank returns, before or after `COMPLETED`, reports `PENDING_REVERSAL` while it is refunded, then `REVERSED`, refunded less the reversal fee (see `reversal`).