APIWebhooksPay OutPay Out Settlement Webhooks

Settlement Released

View as MarkdownOpen in Claude

Triggered when a pay out batch settlement is released from hold.

Notification name: payout_batch_settlement_released

Payload

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

The name of the merchant/paypoint

TextstringRequired

Human-readable description of the event

transferIdstringRequired
Unique transfer identifier
NetAmountstringRequired
Net transaction amount in currency format
TotalAmountstringRequired
Total transaction amount including fees
RtAmountstringRequired
Return amount in currency format
transferTimestringRequired

Transfer timestamp in M/D/YYYY H:mm:ss format

batchIdstringRequired
Unique batch identifier
ContactUsstringRequired
Contact information string
batchNumberstringRequired

Batch number identifier (UUID format)

entryPointstringRequired
System entry point identifier
ExternalPaypointIdstring or nullRequired
External paypoint system identifier

Response

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