Documentation / Syncing

Transactions

Incrementally sync transactions with complete records, removals, and durable cursors.

transactions · bash
curl --get "$BASE_URL/sdk/v1/transactions/sync" \
  -H "X-Application-Id: $APP_ID" \
  -H "X-Api-Key: $API_KEY" \
  --data-urlencode "limit=100"
All documentation

GET /sdk/v1/transactions/sync

Sync the agency wallet ledger, including new entries and corrections to existing transaction status or amount. Replace by id, which equals transactionId.

Requires X-Application-Id, X-Api-Key, and payouts:read. Follow the shared syncing workflow for pagination, cursor storage, retries and removals. Only cursor and limit are accepted.

curl --get "$BASE_URL/sdk/v1/transactions/sync" \
  -H "X-Application-Id: $APP_ID" \
  -H "X-Api-Key: $API_KEY" \
  --data-urlencode "limit=100"

On subsequent requests, add --data-urlencode "cursor=$SAVED_CURSOR".

Record format

Each item in data is a complete replacement with these fields:

{
  "id": "TX_123",
  "transactionId": "TX_123",
  "transactionType": "WALLET_TO_WALLET",
  "transactionStatus": "COMPLETED",
  "amount": "-120.50",
  "currency": "USD",
  "invoiceId": "INV_123",
  "transactionTime": "2026-10-26T10:00:00.000Z"
}

amount is the exact stored ledger amount in currency, serialized as a decimal string. Preserve its sign; debits are negative. Use decimal arithmetic. This is not a converted display total or the net bank/top-up amount shown by other views. transactionStatus retains the ledger's status enum.

Internal admin adjustments and FX top-up fee revenue are excluded, consistently with the public transaction list. Processor payloads, payment credentials, internal metadata and source-of-funds details are never returned.

Wallet ownership changes, removal, and records leaving this public ledger view produce removals. This feed covers stored ledger state; fulfillment and withdrawal state are available in the payout feed.

Describe your program.

Grade turns it into a program it can track and pay.