Events

Events list

We trigger an event when we make a change to a resource or complete a process, for example, when we change the status of a processing account.

When you subscribe to an event, each time we trigger it we send you a notification to inform you about the change. We send the notification by a webhook request to an endpoint that you specify when you subscribe to the event. For more information about how to subscribe to events, go to Create an event subscription.

Note: If we don’t receive a 200 response to the webhook request, we retry the request up to five times. If the request is still unsuccessful after five retry attempts, we contact the support email address that you specified when you subscribed to the event.

CloudEvents attributes

We use the CloudEvents standard to format our event notifications. Each notification has the following attributes:

AttributeDescription
specversionVersion of the CloudEvents specification that the event notification follows.
typeType of event that occurred.
versionVersion of the event type in our specification.
sourceIndicates the origin of the event.
idUnique identifier of the event.
timeTime stamp of the event.
datacontenttypeIndicates the format of the data object.
dataInformation about the change that triggered the event.

Example

1{
2  "specversion": "1.0",
3  "type": "processingAccount.status.changed",
4  "version": "1.0",
5  "source": "payroc",
6  "id": "123e4567-e89b-12d3-a456-426614174000",
7  "time": "2024-07-02T15:30:00.000Z",
8  "datacontenttype": "application/json",
9  "data": {
10    "processingAccountId": "38765",
11    "status": "entered"
12  }
13}

Events

You can subscribe to the following events with our API:

TypeChangeResourceVersion
processingAccount.status.changedWe have changed the status of a processing account.Boarding1.0
processingAccount.funding.status.changedWe have changed the funding status of a processing account.Boarding1.0
terminalOrder.status.changedWe have changed the status of a terminal order.Boarding1.0