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

Batch Resolved

Triggered when a pay in batch is resolved. Notification name: `payin_batch_resolved`
Was this page helpful?
Previous

Batch On Hold

Next
Built with
Batch On Hold
Payload
1{
2  "Event": "ResolvedBatch",
3  "Paypoint": "Gruzya Adventure Outfitters",
4  "Text": "A batch has been resolved for Gruzya Adventure Outfitters",
5  "batchId": 124055,
6  "batchAmount": "40.77",
7  "batchDate": "9/2/2025 12:00:00 AM",
8  "ContactUs": "https://www.sceptre.com | +(798) 326-4657",
9  "ExternalPaypointId": null
10}

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

Response

200
any
Return a 200 status to indicate that the data was received successfully.
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"ResolvedBatch"Required
Event type identifier
PaypointstringRequired

The name of the merchant/paypoint

TextstringRequired

Human-readable description of the event

batchIdstringRequired
Unique batch identifier
batchAmountstringRequired
Batch amount in currency format
batchDatestringRequired

Batch date in M/D/YYYY format

ContactUsstringRequired
Contact information string
ExternalPaypointIdstring or nullRequired
External paypoint system identifier
The content length of the payload
String header field

Always application/json; charset=utf-8

Content types accepted, typically * /*

Triggered when a pay in batch is resolved.

Notification name: payin_batch_resolved