APIWebhooksPay OutPay Out Batch Webhooks

Batch On Hold

View as MarkdownOpen in Claude

Triggered when a pay out batch is placed on hold.

Notification name: payout_batch_onhold

Payload

The payload of this webhook request is an object.
Event"PayOutBatchOnHold"Required
Event type identifier
PaypointstringRequired

The name of the merchant/paypoint

TextstringRequired

Human-readable description of the event

BatchIdstringRequired
Unique batch identifier
TotalAmountstringRequired
Total transaction amount including fees
MethodstringRequired
Payment processing method
entryPointstringRequired
System entry point identifier

Response

200
Acknowledged. The subscriber returns 200 to confirm receipt. Any other status causes Payabli to retry delivery.