Skip to navigation
WebhooksPay InTransaction & Batch Webhooks

Batch On Hold

View as MarkdownOpen in Claude

Triggered when a Pay In batch is placed on hold.

Notification name: payin_batch_onhold

Payload

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

The name of the merchant/paypoint

TextstringRequired

Human-readable description of the event

batchIdintegerRequired
Unique batch identifier
batchAmountstringRequired
Total batch amount
batchDatestringRequired
Batch date
ContactUsstringRequired
Contact information string
ExternalPaypointIdstringRequired
External paypoint system identifier

Response

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