Payments API ReferenceOrganization Webhooks

Ping a webhook endpoint (creates and sends a synthetic event)

Path parameters

organizationIdstringRequired
webhookIdstringRequired

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
dataobjectOptional
Optional additional data to include in ping payload

Response

idstring
organizationIdstring
typestring
versionstring
occurredAtstringformat: "date-time"
payloadstring

Stringified JSON payload (redacted in read APIs)

createdAtstringformat: "date-time"
merchantIdstring or null
requestIdstring or null

Errors