Cancel points transaction

Description

Cancels any points transaction — temporary or permanent. When canceled, the current active points balance is recalculated.

Request URL

Method: POST

https://example.com/api/v1.1/loyalty/cancel_transaction

Request parameters

Parameter	Type	Example	Required	Description
transaction_id	string	"TRANS12345"	No	Transaction ID
transaction_eid	string	"TRANS12345"	No	External transaction ID

At least one identifier must be provided.

Request example

JSON

{
  "transaction_id": "TRANS12345"
}

XML

<xml>
  <transaction_id>TRANS12345</transaction_id>
</xml>

Response example

JSON

{
  "error": 0,
  "error_text": "Successful operation",
  "data": {
    "transaction_id": "TRANS12345",
    "balance": "399.50"
  }
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
  <data>
    <transaction_id>TRANS12345</transaction_id>
    <balance>399.50</balance>
  </data>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
transaction_id	string	Canceled transaction ID
balance	string	Active points balance after cancellation