Payer B2B Events 1

Events may be sent for certain actions in Payer B2B.

To subscribe for events, use the POST /api/v1/events/callbacks method below and specify which URL the event should be sent to. It is possible to subscribe to the same event with multiple callback URLs.

When Payer B2B invokes your registered callback URL, it will append a token query parameter that can be used to fetch the event payload and acknowledge the event.

Payer B2B will invoke the callback multiple times with an exponential backoff timer until the event is acknowledged using GET /api/v1/events/{token}/ack. The the callback is invoked at most 10 times with ~4h30m between the first and last attempt.

After an event is acknowledged, no more callbacks will be made and it will no longer be possible to fetch the event payload. If you are interested in the payload, make sure to fetch it before the event is acknowledged using GET /api/v1/events/{token}.

Payer B2B can not guarantee that events are never delivered again after acknowledging so the consumer is encouraged to keep track of event tokens to determine if events are unique.

Available event types can be found by expanding the Events API -> POST /api/v1/events/callbacks method. Available event payloads can be found by expanding Models. Event payloads are named the same as EVENT_TYPES, but with PascalCase and are postfixed with Payload. Ex: The INVOICE_PAYMENT_RECEIVED event has a payload named InvoicePaymentReceivedPayload.