Boarding Service Status Change
Overview
The BoardingServiceStatusChange event fires when a merchant application's boarding status is changed by an external party, such as a processor. Use this event to track processor-driven boarding progress for an application, including the boarding service name and its new status.
Trigger Conditions
This event is triggered when:
- An external party changes a boarding status — for example, a processor updates the boarding service status for a merchant application.
This event fires only when the status change is made by an external party. Changes made by internal users through the New Accounts interface or API do not trigger this webhook.
Payload Schema
Top-Level Fields
| Field | Type | Description |
|---|---|---|
Type | Integer | Always 11 for this event. |
EventIdentifier | String | Always BoardingServiceStatusChange. |
EventData | Object | Contains the boarding service details. See EventData Fields below. |
EventData Fields
| Field | Type | Description |
|---|---|---|
BoardingServiceId | Integer | The boarding service ID for the cobrand. |
BoardingServiceName | String | The boarding service title. |
BoardingServiceStatus | String | The boarding service status (for example, Working). |
MerchantApplicationId | Integer | The merchant application ID. |
InfiniceptApplicationId | Guid | The unique ID for Infinicept applications. |
ExternalApplicationId | String | The ID that can be set by external users when creating the merchant application via API. |
Example Payload
{
"Type": 11,
"EventIdentifier": "BoardingServiceStatusChange",
"EventData": {
"BoardingServiceId": 1009,
"BoardingServiceName": "Manual/External Processor Boarding",
"BoardingServiceStatus": "Working",
"MerchantApplicationId": 26652,
"InfiniceptApplicationId": "a07a2fbe-0f0a-4301-a7ff-c88a9d07a781",
"ExternalApplicationId": null
}
}Handling This Event
- Read
BoardingServiceStatusto determine the new status the processor reported for the boarding service. - Use
BoardingServiceNameandBoardingServiceIdto identify which configured boarding service the change applies to. - Match on
MerchantApplicationIdto associate the change with the correct application in your system. - Store
InfiniceptApplicationIdandExternalApplicationIdto correlate this event with records in your own system.
Support
Have a question? Contact us on the Customer Support Portal.
Learn about updates in our Changelog.
Updated about 2 months ago
Did this page help you?
