Skip to navigation
API ReferenceWebhook

Webhooks - send notifications to partners

Sends updates to the Partner for changes related to enrollment, intent, or payment credentials. Notifications are triggered based on lifecycle events within the system. The request payload is JWE-encrypted on the wire.

Authentication

AuthorizationBearer

OAuth 2.0 client credentials. Exchange your API key and secret for a bearer token, then send it as Authorization: Bearer <token>.

Headers

AuthorizationstringRequired

The OAuth authorization header generated as prescribed in the Oauth 2.0 guide

trackingIdstringRequired
A unique identifier for request tracking.
agentIdstringRequired
Agent's unique identifier.

Request

Notification request payload containing updates related to enrollment, intent, or payment credentials. The request payload is JWE-encrypted on the wire.

OR
OR

Response

Successful response

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error