Skip to navigation
WebhooksPay OpsBoarding Webhooks

Application on Hold

View as MarkdownOpen in Claude

Triggered when a boarding application is placed on hold.

Notification name: holdingapplication

Payload

The payload of this webhook request is an object.
Event"HoldingApplication"Required
Event type identifier
TextstringRequired

Human-readable description of the event

LegalNamestringRequired
The merchant's legal business name
DbaNamestringRequired

The merchant’s DBA (doing-business-as) name

AppIDintegerRequired
Unique boarding application identifier
createdAtstringRequired
Creation timestamp
SoftwarePartnerstringRequired
The software partner associated with the application
PolicyIdstring or nullRequired
Underwriting policy identifier, when applicable
ApplicationTokenstring or nullRequired
Boarding application token, when applicable
ExternalPaypointIdstringRequired
External paypoint system identifier

Response

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