Retrieve Transactions API Documentation

The Retrieve Transactions endpoint provides a partner with the ability to retrieve Avios transactions (credits and debits) for an identified member’s account. A partner consuming this service will be able to return either the most recent transactions, or a subset of any of the transactions for the account in question.

The Retrieve Transactions API requires the Partner to have generated an access token for the member prior to invocation. This access token must be included in any request message along with other data elements relating to the partner’s configuration. The remainder of this document describes the request and response messages, the correct use of the service and possible exceptions and error states that may present in the response.

Business Context

Here’s the process flow:

• An identified member, for whom the partner has a valid access token, initiates a journey in the partner application that requires the member’s Avios transaction data.
• The partner receives the member’s request and invokes the Retrieve Transactions endpoint, providing a request that contains the member’s access token, membership number and data elements that identify the partner.
• The Retrieve Transactions endpoint receives and processes the request, returning an appropriate response or error.
• Partner finalises processing of transactions, presenting these in an appropriate manner to the member.
• Member continues their journey in the partner application.

Technical Context

Important Technical Notes

• Request elements are not stored.
• All enumerated values must be upper case.
• Elements in the response message will always be returned in upper case ASCII.
• All query parameters must be supplied in lower case.

Pre-conditions

• An Access Token, generated at the point of Member login via Create Token endpoint must be supplied in the request when invoking this service.
• Partner needs a valid API key to access this endpoint.

Post-conditions

Success outcome: Transaction details are returned in the endpoint response message.

Error outcome: Service error is returned.

Service Details

URI Parameters

Production Endpoint:

'GET https://api.avios.com/{version}/programmes/{programme-identifier}/accounts/{account-identifier}/transactions?api_key={api_key}'

Example URI

https://api.avios.com/v1/programmes/ATRP/accounts/3081470000000000/transactions?api_key=abcdef

Request Headers

Request Elements

The following shows examples of request calls to the Retrieve Transactions endpoint:

Without Query Parameters:

https://api.avios.com/test/v1/programmes/ATRP/accounts/3081471017300186/transactions?api_key=xxx

With Range Filter:

https://api.avios.com/test/v1/programmes/ATRP/accounts/3081471017300186/transactions?api_key=xxx&start-record=1&end-record=10&date-made-from=2016-01-01&date-made-to=2016-09-01

With Range and match Filter:

https://api.avios.com/test/v1/programmes/ATRP/accounts/3081471017300186/transactions?api_key=xxx&start-record=1&end-record=10&date-made-from=2016-01-01&date-made-to=2016-09-02&external-source=Lloy

Response Elements

Example Response:

Without Query Parameters:

{
  "transaction": [
    {
      "creditTransaction": {
        "identifier": "6965162461003",
...Show more

With Range Filter:

{
  "transaction": [
    {
      "debitTransaction": {
        "identifier": "395079D03F46027BE050A8C0020A62BD",
...Show more

With range and match filter:

{
  "transaction": [
    {
      "creditTransaction": {
        "identifier": "6965162461003",
...Show more

Exception Message Elements

Error Response:

{
  "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: