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.

FieldTypeDescription
TypeInteger11 (BoardingServiceStatusChange)
EventIdentifierStringWebhook event name
EventDataObject
BoardingServiceIdIntegerBoarding service ID for the cobrand
BoardingServiceNameStringBoarding service title
BoardingServiceStatusStringBoarding service status
MerchantApplicationIdIntegerMerchant application ID
InfiniceptApplicationIdGuidUnique ID for Infinicept applications
ExternalApplicationIdStringID 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
	}
}