WebhooksPay OutPay Out Settlement Webhooks

Settlement Funded

Triggered when a pay out batch settlement is funded.

Notification name: payout_batch_settlement_funded

Headers

Content-LengthstringRequired
The content length of the payload
Content-TypestringRequired

Always application/json; charset=utf-8

AcceptstringRequired

Content types accepted, typically * /*

StringstringRequired
String header field
HoststringRequired

Host IP address (52.3.204.115 for sandbox, 54.166.54.170 for production)

Payload

The payload of this webhook request is an object.
Event"TransferFunded"RequiredDefaults to TransferFunded
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
any
Return a 200 status to indicate that the data was received successfully.