Reverse Transaction API Documentation

The Reverse Transaction endpoint is intended to reverse previously processed debit transactions. Identification details of the transaction to be reversed are passed in the request. The entire amount for the given transaction will be reversed and a transaction identifier for the reversed transaction will be supplied in the response. Before invoking this service, an access token should be obtained from a successful call to the Create Token endpoint.

Business Context

Here’s the process flow:

• The member undertakes a purchase journey and the account is debited appropriately. However, if for any reason a problem is detected post debit, the transaction will need to be reversed.
• This is automatically performed within the partner application by means of a call to the Reverse Transaction endpoint.
• This service creates a transaction that reverses the debit previously done as described above.

Important Technical Notes

• All enumerated values must be recorded in upper case ASCII characters. Response messages will be returned in upper case.

Pre-conditions

• An access token is obtained from a successful authentication call to the Create Token endpoint. Access token must be generated with reverse_transaction scope.
• A transaction must have been created, which requires reversal.
• The reversal request must be placed within the permitted time after the original transaction for it to get reversed.

Post-conditions

Success outcome: A reversal of the original debit transaction is made to the member’s account.

Error outcome: Service error is returned.

Service Details

URI Parameters

Production Endpoint:

'POST https://api.avios.com/{version}/programmes/{programme-identifier}/accounts/{account-identifier}/reverse-transaction-requests?api_key={api_key}'

Example

https://api.avios.com/v1/programmes/ATRP/accounts/3081470000000000/reverse-transaction-requests?api_key=abcdef

Request Headers

Request Elements

Example of a Request Call to the Reverse Transaction endpoint:

{
  "reversalTransaction": {
    "externalTransactionIdentifier": "12",
    "type": "CANCELLATION",
    "description": "dfs",
...Show more

Response Elements

The following is an example of a response generated by the Reverse Transaction endpoint:

{
  "reversalTransaction": {
    "identifier": "3875243275825CB1E050A8C0021A4B4A",
    "dateMade": "2016-12-19T10:46:00.696Z",
    "externalTransactionIdentifier": "12",
...Show more

The elements that make up the response message are detailed in the following table:

Exception Message Elements

The following shows examples of error responses generated by the Reverse Transaction endpoint:

Example 1: Application error:

{
  "error": {
    "code": "REVERSAL_NO_LONGER_PERMITTED",
    "businessMessage": "Reversal No Longer Permitted",
    "developerLink": "https://developer.iagloyalty.com"
...Show more

Example 2: Validation error:

{
  "error": {
    "code": "REQUEST_INVALID",
    "businessMessage": "Request Invalid",
    "developerLink": "https://developer.iagloyalty.com/docs",
...Show more

Error Codes

The elements that make up the error messages are detailed in the following table: