Boarding Service Status Change Webhook
You can subscribe to changes to a merchant application's boarding status triggered by a processor using the BoardingServiceStatusChange webhook. Information received in the notification includes Boarding Service Name, Boarding Service Status, Merchant Application ID, and more.
NOTE: This webhook triggers only when a status change is made by an external party such as a processor. Changes made by internal users using the New Accounts interface and API do not trigger this webhook.
Response Schema
See the table below for information received in the webhook response.
| Field | Type | Description |
|---|---|---|
| Type | Integer | 11 (BoardingServiceStatusChange) |
| EventIdentifier | String | Webhook event name |
| EventData | Object | |
| BoardingServiceId | Integer | Boarding service ID for the cobrand |
| BoardingServiceName | String | Boarding service title |
| BoardingServiceStatus | String | Boarding service status |
| MerchantApplicationId | Integer | Merchant application ID |
| InfiniceptApplicationId | Guid | Unique ID for Infinicept applications |
| ExternalApplicationId | String | ID that can be set by external users when creating the merchant application via API |
Example JSON Response
See an example of the webhook response below.
{
"Type":11,
"EventIdentifier":"BoardingServiceStatusChange",
"EventData":{
"BoardingServiceId":1009,
"BoardingServiceName":"Manual/External Processor Boarding",
"BoardingServiceStatus":"Working",
"MerchantApplicationId":26652,
"InfiniceptApplicationId":"a07a2fbe-0f0a-4301-a7ff-c88a9d07a781",
"ExternalApplicationId":null
}
}Updated 5 months ago
