Skip to main content

Schemes

All scheme events will return the following scheme object. This is the same object as the Scheme API returns. API Endpoint

{
  "merchantCode": "string",
  "id": "string",
  "provider": "string",
  "bin": "string",
  "caid": "string",
  "location": "string",
  "doingBusinessAsName": "string",
  "channel": "string",
  "registeredDate": "2025-10-14T03:33:28.496Z",
  "deregisteredDate": "2025-10-14T03:33:28.496Z",
  "status": "string"
}

Events

schemeregistration.added - This event will be triggered every time a scheme is added to the program.
schemeregistration.updated - This event will be triggered every time a scheme is updated from a program.
schemeregistration.register - This event will be triggered every time a scheme is registered to the program.
schemeregistration.removed - This event will be triggered every time a scheme is removed from the program.

Events