Order Canceled Notification

This sends a notification to the third-party application that an order is being canceled by either the consumer or the provider. See example and descriptions below;

{
  "CheckSum": "7423ACC55801F2EDB1E756725CB61182D40988620EEF40BA2C3CCEB25E479423DA656F62CBEC1DFEF1EA0FBF09311F9FF689DF47DE9517D79E137CE165114FF3",
  "Data": {
    "OrderId": "844059b7-88ea-4b73-daca-08d9eb0f6c4a",
    "OrderReference": "XB_0cb80c382cd343ae9600cf6b177be55a",
    "OrderStatus": 2,
    "InitiatedBy": 0
  }
}

Key Type Description

Key	Type	Description
`Checksum`	string	This is a hash property signed with the merchant `secretkey`.
`Data`	object	This holds the properties of the payload data details.
`OrderId`	guid	This is the order id in the database.
`OrderReference`	string	This is the reference of the order in the database.
`OrderStatus`	enum	This is the status of an order at a particular time. It can be `Submitted = 1`, `Cancelled = 2`, `Acknowledged = 3`, `FundedProvider = 4`, `FundReceivedFromUser = 5`, `FundedUser = 6` or `Completed = 7`.

Checksum

string

This is a hash property signed with the merchant secretkey.

Data

object

This holds the properties of the payload data details.

OrderId

guid

This is the order id in the database.

OrderReference

string

This is the reference of the order in the database.

OrderStatus

enum

This is the status of an order at a particular time. It can be Submitted = 1, Cancelled = 2, Acknowledged = 3, FundedProvider = 4, FundReceivedFromUser = 5, FundedUser = 6 or Completed = 7.

PreviousOrder Matched Notification NextChecksum Verification

Last updated 1 year ago