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

FieldTypeDescription
TypeIntegerAlways 11 for this event.
EventIdentifierStringAlways BoardingServiceStatusChange.
EventDataObjectContains the boarding service details. See EventData Fields below.

EventData Fields

FieldTypeDescription
BoardingServiceIdIntegerThe boarding service ID for the cobrand.
BoardingServiceNameStringThe boarding service title.
BoardingServiceStatusStringThe boarding service status (for example, Working).
MerchantApplicationIdIntegerThe merchant application ID.
InfiniceptApplicationIdGuidThe unique ID for Infinicept applications.
ExternalApplicationIdStringThe 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

  1. Read BoardingServiceStatus to determine the new status the processor reported for the boarding service.
  2. Use BoardingServiceName and BoardingServiceId to identify which configured boarding service the change applies to.
  3. Match on MerchantApplicationId to associate the change with the correct application in your system.
  4. Store InfiniceptApplicationId and ExternalApplicationId to 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.




Did this page help you?