Status PageContact sales
DevelopersIntegration guidesEmbedded componentsSDKs & toolsAPI reference
  • Using the API
    • API overview
    • API responses
  • API
  • Webhooks
LogoLogo
Status PageContact sales
WebhooksPay InPay In Settlement Webhooks

Settlement Exception

Triggered when a pay in batch settlement encounters an exception. Notification name: `payin_batch_settlement_exception`
Was this page helpful?
Previous

Settlement ACH Return/Chargeback

Next
Built with
Payload
1{
2  "Event": "TransferException",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "A transfer error occurred for Gruzya Adventure Outfitters",
5  "transferId": 124055,
6  "NetAmount": "40.77",
7  "TotalAmount": "0.00",
8  "CbAmount": "0.00",
9  "RtAmount": "0.00",
10  "transferTime": "9/16/2025 3:15:30 PM",
11  "batchId": 124055,
12  "ContactUs": "https://www.example.com | +(555) 555-5555",
13  "batchNumber": "batch_settlement_124055_092025",
14  "entryPoint": "entry124",
15  "ExternalPaypointId": null
16}

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"TransferException"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
CbAmountstringRequired
Chargeback amount in currency format
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.

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

Content types accepted, typically * /*

Settlement ACH Return/Chargeback

Triggered when a pay in batch settlement encounters an exception.

Notification name: payin_batch_settlement_exception