Payout Webhook

Payload shape for payout webhooks.

Content

KeyTypeDescription
uuidstring
  • Public payout ID
  • 8 - 40 characters long
modestring
  • Payout mode
  • Possible values: TEST or LIVE
objectstringAlways payout
amountintTotal payout amount
total_feesintTotal of fees within the payout
currencystringISO 4217 of currency
datestringThe date of the payout in the format 2026-01-16
statementstringBank statement
payerstring
  • The initiator of the payout
  • API literals: stripe, payrexx or unknown
  • payrexx = payout via the zahls.ch platform (fixed API value)
statusstringPayout status
destinationDestination/pages/YygrNHZQe3ac30hw0yVT
transfersarray of Transfers/pages/qEnCtEeLf29gXI6NTJla
merchantMerchant/pages/IJRz4SJrJsG1l41FyNeh
is_manual_payoutboolWas the payout created by hand by the merchant

Status Values

StatusDescription
initiated *Payout has been initiated by the system
pending *Payout is created and ready for processing
under-review *Payout needs to be investigated in more detail
processingPayout file is sent by the bank
sentPayout transmitted successfully to the bank
failedPayout failed and returned from bank

Example

{
  "uuid": "AABB1122",
  "mode": "TEST",
  "object": "payout",
  "amount": 29390,
  "total_fees": 310,
  "currency": "CHF",
  "date": "2026-01-06",
  "statement": "zahls.ch Demo Shop Thun",
  "payer": "payrexx",
  "status": "processing",
  "destination": {
    "type": "bank_account",
    "iban": "CH36 8914 4576 4981 8798 3",
    "account_holder": "Demo Firma CH"
  },
  "transfers": [
    {
      "type": "payout-fee",
      "amount": -10,
      "date_time": "2026-01-06T13:45:18+00:00",
      "items": [
        {
          "type": "payout-fee",
          "amount": -10
        }
      ],
      "transaction": {}
    },
    {
      "type": "transaction",
      "amount": 29400,
      "date_time": "2025-12-25T13:44:30+00:00",
      "items": [
        {
          "type": "transaction",
          "amount": 30000
        },
        {
          "type": "transaction-fee",
          "amount": -300
        }
      ],
      "transaction": {
        "type": "transaction",
        "amount": 30000,
        "uuid": "aabb1122",
        "fee": 300,
        "currency": "EUR",
        "time": "2026-01-06T14:44:31+01:00",
        "payment": {
          "brand": "visa"
        },
        "reference_id": ""
      }
    }
  ],
  "merchant": {
    "name": "demo",
    "site_title": "zahls.ch",
    "owner": {
      "company": "Demo Firma",
      "first_name": "Jane",
      "last_name": "Doe",
      "address": "Burgstrasse 20",
      "zip": "3600",
      "place": "Thun",
      "email": "test@zahls.ch"
    }
  },
  "is_manual_payout": false
}