Build cross-border payments with the Onboard API

Full payload schemas are in WebHook Events.

Event family	Fires when
`transaction_activity.cash_deposit.*`	A cash deposit is created, matched, or settled (`.created`, `.updated`, `.completed`, `.failed`)

Sample payload

Full field-by-field schema is in WebHook Events. activityData is a CashDepositTransaction — note the terminal success status is SUCCESS, not COMPLETED.

{
  "event": "transaction_activity.cash_deposit.completed",
  "data": {
    "id": "1b3e6c2a-9f41-4b8e-8a2d-5c7f9e1a3b04",
    "activityType": "CashDepositActivity",
    "type": "CASH_DEPOSIT",
    "direction": "CREDIT",
    "amount": 32.50,
    "currency": "USD",
    "status": "SUCCESS",
    "reference": "0173270620673048624933",
    "accountId": "d9e9f9c1-6a3b-4b2e-8b3a-2f1e4d5c6b7a",
    "accountType": "SUB_ACCOUNT",
    "subAccountId": "6f9d3a2e-1b5c-4e88-9a2f-3c7d5e9b1a04",
    "activityAt": "2026-07-22T13:59:12.140Z",
    "activityData": {
      "id": "3c7f9e1a-3b04-4e88-9a2f-1b3e6c2a5c7d",
      "reference": "0173270620673048624933",
      "currency": "USD",
      "status": "SUCCESS",
      "payinCurrency": "NGN",
      "amount": 32.50,
      "rate": 1538.46,
      "payinAmount": 50000.00,
      "createdDate": "2026-07-22T13:57:56.970Z"
    }
  },
  "timestamp": 1784728752
}

Getting Started

API Concepts

Product Features

Use Cases

Webhooks for Cash Deposits

Sample payload

​Sample payload

Sample payload