Payout

Content

Key	Type	Description
uuid	string	Public payout ID 8 - 40 characters long
mode	string	Payout mode Possible values: TEST or LIVE
object	string	Always payout
amount	int	Total payout amount
total_fees	int	Total of fees within the payout
currency	string	ISO 4217 of currency
date	string	The date of the payout in the format 2026-01-16
statement	string	Bank statement
payer	string	The initiator of the payout Possible values: stripe, payrexx or unknown
status	string	Payout status
destination	Destination	Destination
transfers	array of Transfers	Transfer
merchant	Merchant	Merchant
is_manual_payout	bool	Was the payout created by hand by the merchant

Status Values

Status	Description
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
processing	Payout file is sent by the bank
sent	Payout transmitted successfully to the bank
failed	Payout failed and returned from bank

* Webhooks are not triggered for the "initiated", "pending", and "under-review" statuses.

Example

{
  "uuid": "AABB1122",
  "mode": "TEST",
  "object": "payout",
  "amount": 29390,
  "total_fees": 310,
  "currency": "CHF",
  "date": "2026-01-06",
  "statement": "Payrexx 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": "Payrexx",
    "owner": {
      "company": "Demo Firma",
      "first_name": "Jane",
      "last_name": "Doe",
      "address": "Burgstrasse 20",
      "zip": "3600",
      "place": "Thun",
      "email": "[e-mail]"
    }
  },
  "is_manual_payout": false
}