> ## Documentation Index
> Fetch the complete documentation index at: https://docs.onboard.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhooks for Cash Payouts

Full payload schemas are in [WebHook Events](/api-reference/webhook-events).

| Event                                       | Fires when                                                                                         |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------- |
| `account_activity.fiat_beneficiary.created` | A fiat beneficiary is added                                                                        |
| `account_activity.fiat_beneficiary.deleted` | A fiat beneficiary is deleted                                                                      |
| `transaction_activity.cash_payment.*`       | A cash payout is created, processing, or settled (`.created`, `.updated`, `.completed`, `.failed`) |

### Sample payloads

Full field-by-field schemas for every event are in
[WebHook Events](/api-reference/webhook-events).

<AccordionGroup>
  <Accordion title="account_activity.fiat_beneficiary.created">
    ```json theme={null}
    {
      "event": "account_activity.fiat_beneficiary.created",
      "data": {
        "id": "5a83377d-7c57-4725-992f-9c50349af917",
        "accountNumber": "0123456789",
        "accountName": "Jane Doe",
        "currency": "GHS",
        "beneficiaryType": "BeneficiaryLocalBankAccount",
        "bankName": "GCB Bank",
        "bankCode": "040",
        "isThirdParty": false,
        "accountHolderType": "INDIVIDUAL"
      },
      "timestamp": 1784657062
    }
    ```
  </Accordion>

  <Accordion title="transaction_activity.cash_payment.completed">
    `activityData` is a `CashPaymentTransaction` — note the terminal success
    status is `SUCCESS`, not `COMPLETED`.

    ```json theme={null}
    {
      "event": "transaction_activity.cash_payment.completed",
      "data": {
        "id": "9c4b1a2e-7d5f-4a2e-9b1c-3d5f8e6d5c4b",
        "activityType": "CashPaymentActivity",
        "type": "CASH_PAYMENT",
        "direction": "DEBIT",
        "amount": 1200.00,
        "currency": "USD",
        "status": "SUCCESS",
        "reference": "0173270620673048624933",
        "accountId": "d9e9f9c1-6a3b-4b2e-8b3a-2f1e4d5c6b7a",
        "accountType": "MAIN",
        "activityAt": "2026-07-23T11:24:37.000Z",
        "activityData": {
          "id": "5c4b3a2e-9c4b-4a2e-9b1c-7d5f8e6d1a2e",
          "reference": "0173270620673048624933",
          "currency": "USD",
          "status": "SUCCESS",
          "payoutCurrency": "GHS",
          "amount": 1200.00,
          "rate": 15.20,
          "payoutAmount": 18240.00,
          "recipient": {
            "id": "5a83377d-7c57-4725-992f-9c50349af917",
            "accountName": "Jane Doe",
            "beneficiaryType": "BeneficiaryLocalBankAccount",
            "bankName": "GCB Bank",
            "accountIdentifier": "0123456789",
            "paymentChannelId": "BANK_TRANSFER_GHANA"
          },
          "createdDate": "2026-07-23T11:22:00.000Z"
        }
      },
      "timestamp": 1784805877
    }
    ```
  </Accordion>
</AccordionGroup>
