Retrieve Account API Documentation

The Retrieve Account endpoint enables a member to retrieve their account details. The endpoint also allows a partner (the caller of the service) to filter information based on what has been requested. If nothing is explicitly specified then the entire response is returned as per the service response contract.

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.
• The partner receives the member’s request and invokes the Retrieve Account endpoint, providing a request that contains the member’s access token, programme name and membership number.
• The Retrieve Account endpoint receives and processes the request, returning an appropriate response or error.
• The partner finalises processing of account, presenting it in an appropriate manner to the member.
• The member continues their journey in the partner application.

Important Technical Notes

In order to call Retrieve Account, a token must have been obtained via the Create Token endpoint. The following steps are performed by the Retrieve Account application:

• Default values are not assigned to elements that have not been supplied within a request message
• The response is then filtered based on what information the caller of the service (i.e. Partner) has requested. If nothing is explicitly specified then the entire response as per the service response contract is returned.
• Request elements are not stored

Pre-Conditions

• The partner must have a valid API key to access the Retrieve Account endpoint
• An Access Token must be supplied in order to use this service.
• A member identity must have been obtained.

Post Conditions

Success outcome: Account 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}?api_key={api_key}'

Example

https://api.avios.com/v2/programmes/ATRP/accounts/3081470000000000?api_key=abcdefabcdefabcdefabcdef

Request Header

Response Elements

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

Examples of Responses

The following shows 3 examples of responses generated by the Retrieve Account endpoint:

Example 1. Full account data returned:

{
  "accountType": "INDIVIDUAL",
  "accountStatus": "ACTIVE",
  "lastActivityDate": "2016-05-31",
  "balance": {
...Show more

Example 2. Only balance returned from account:

{
  "balance": {
    "amount": 100000,
    "currency": {
      "currencyCode": "AVIOS"
...Show more

Example 3. Last activity date and balance information returned from account:

{
  "lastActivityDate": "2016-05-31",
  "balance": {
    "amount": 100000,
    "currency": {
...Show more

Exception Message Elements

The following shows an example of an error response generated by the Retrieve Account endpoint:

Example of an Error Response

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

Example 2: Note: below errors will differ from other errors with their structure and will come with “error” element as parent of error response:

1. SYSTEM_UNAVAILABLE
2. DEVELOPER_NOT_AUTHORIZED
3. DEVELOPER_INACTIVE
4. USAGE_RATE_EXCEEDED
5. USAGE_RATE_LIMIT_EXCEEDED
6. SSL_REQUIRED
7. GATEWAY_TIMEOUT

{
  "error": {
    "code": "GATEWAY_TIMEOUT",
    "businessMessage": "Request Unauthorized",
    "developerMessage": "Request Unauthorized",
...Show more

Error Codes

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