You can expect the below object when you register a webhook for the following events:
- payout.failed
- payout.processed
Raw sample
{
"reason": "Invoice payment",
"id": "PYT-E30EE749B0",
"name": "Homemade Chocolatier",
"amount": 100.12,
"amount_currency": "AED",
"method": "Bank account",
"recipient": "AE080200000123223333121",
"recipient_id": "REP-54A15E6B47",
"created_at": "2023-12-28-17-22-53",
"status": "processed",
"event_type": "payout.processed"
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| reason | String | Payout reason |
| id | String | Payout ID |
| name | String | Recipient name |
| amount | Number | Payout amount |
| amount_currency | String | Payout currency |
| recipient | String | Recipient IBAN |
| recipient_id | String | Recipient ID |
| method | String | Payout method (BANK_ACCOUNT) |
| created_at | String (Format: YYYY-MM-DD-HH-MM-SS) | Payout creation time |
| status | String | Payout Status |
| event_type | String | Webhook event type |