Introduction

AwardWallet Account Access API

The AwardWallet Account Access API provides access to the loyalty account data that belongs to AwardWallet users. Once authorized by the end user, the API provides access to the loyalty accounts that the user shared with you.

To use this API you need to have a business account, which can be registered here, if you already have a personal AwardWallet account, or here if you don’t have a personal AwardWallet account.

Your API key and other API settings can be found under your business account.

This API will allow you to retrieve information about any of the users that linked their accounts to your business account. You don’t need to have a paid business account in order to use the API. However, if you need a nice UI interface to see all of the users who shared their loyalty accounts with your business, you can use our business interface to do that.

If you wish to be able to invite users to link their accounts to your business interface you need to request that form the AwardWallet team by sending a description of your business and intended use case.

Once approved by AwardWallet you will get a special link (which can be found under your business interface) to which you can send your users so that they can authorize your access to their AwardWallet accounts. There are two URLs, the default one is:

https://awardwallet.com/m/#/connections/approve/{specialCode}/{access}

but if you wish to use our full blow desktop interface you can also us this URL:

https://awardwallet.com/user/connections/approve?id={specialCode}&access={access}&granularSharing=false

There are two URL parameters you can modify:

  • access – accepts values 0 – 3 as described under accountsAccessLevel attribute under the Get Connected User Details response.
  • granularSharing – by default set to false, if set to true users will be given a link that allows them to go into their AwardWallet profile and granularly select which accounts they wish to share.

Finally, you can have two types of members under your business interface:

  • Connected Users – these are the users who have their own personal AwardWallet credentials who chose to connect their accounts to your business account. They can choose granularly what exactly they wish to share with you.
  • Members – basically these are just names you add under your business interface. They make your life easier when organizing stuff under your business interface. These members don’t have an AwardWallet account and therefore are not linked to you the same way as Connected Users are.

Since these two entities are quite different you need to use two different API calls to get info about them.

Authentication

To authorize, use this code:

                    
# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "X-Authentication: userapikey"
                    
                

Every API call needs to be authenticated with an API key. This key is passed in the "X-Authentication" field with the https request header. You can get your personal API key in the account settings of your business account.

X-Authentication: userapikey

Accounts

Get Account Details

Response Example

                            
{
  "account": [
    {
      "accountId": 7654321,
      "displayName": "British Airways (Executive Club)",
      "kind": "Airlines",
      "login": "johnsmith",
      "autologinUrl": "https://business.awardwallet.com/account/redirect.php?ID=7654321",
      "updateUrl": "https://business.awardwallet.com/account/edit/7654321?autosubmit=1",
      "editUrl": "https://business.awardwallet.com/account/edit/7654321",
      "balance": "146,780",
      "balanceRaw": 146780,
      "owner": "John Smith",
      "errorCode": 1,
      "lastDetectedChange": "+750",
      "expirationDate": "2018-12-10T00:00:00+00:00",
      "lastRetrieveDate": "2016-01-15T00:00:00+00:00",
      "lastChangeDate": "2016-01-15T00:49:33+00:00",
      "properties": [
        {
          "name": "Next Elite Level",
          "value": "Bronze",
          "kind": 9
        },
        {
          "name": "Date of joining the club",
          "value": "20 Jun 2013",
          "kind": 5
        },
        {
          "name": "Lifetime Tier Points",
          "value": "35,000"
        },
        {
          "name": "Executive Club Tier Points",
          "value": "35,000"
        },
        {
          "name": "Card expiry date",
          "value": "31 Mar 2017"
        },
        {
          "name": "Membership year ends",
          "value": "08 Feb 2016"
        },
        {
          "name": "Last Activity",
          "value": "10-Dec-15",
          "kind": 13
        },
        {
          "name": "Name",
          "value": "Mr Smith",
          "kind": 12
        },
        {
          "name": "Level",
          "value": "Blue",
          "rank": 0,
          "kind": 3
        },
        {
          "name": "Membership no",
          "value": "1122334455",
          "kind": 1
        }
      ],
      "history": [
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "3/31/14"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "12/11/13"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Google Wallet"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Other Earning"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "+100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "9/30/12"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-1,042"
            }
          ]
        }
      ]
    }
  ],
  "connectedUser": {
    "userId": 12345,
    "fullName": "John Smith",
    "status": "Free",
    "userName": "JSmith",
    "email": "JSmith@email.com",
    "forwardingEmail": "JSmith@AwardWallet.com",
    "accessLevel": "Regular",
    "connectionType": "Connected",
    "accountsAccessLevel": "Full control",
    "accountsSharedByDefault": true,
    "editConnectionUrl": "https://business.awardwallet.com/members/connection/112233",
    "accountListUrl": "https://business.awardwallet.com/account/list#/?agentId=112233",
    "timelineUrl": "https://business.awardwallet.com/timeline/?agentId=166765#/112233",
    "bookingRequestsUrl": "https://business.awardwallet.com/awardBooking/queue?user_filter=332211"
  }
}
                            
                        

Using the accountId found in either the /member, /member/{id}, /connectedUser, or /connectedUser/{id} methods you can get a comprehensive list of all the account details including the entire transaction history list for that specific account.

HTTP Request

GET https://business.awardwallet.com/api/export/v1/account/{id}

Query Parameters

Parameter Type Required Description
id integer true

accountId

Response

Parameter Type Required Description

account

object true

An object that describes the Account

member

object false

An object that describes the Member to whom this account is linked.

connectedUser

object false

An object that describes the ConnectedUser to whom this account is linked.

ConnectedUser

Parameter Type Required Description

userId

integer true

Unique ID that identifies a given User

fullName

string true

Full name that User provided during registration

email

string true

Email address of a User

forwardingEmail

string true

AwardWallet email address of a User that can be used for forwarding User itineraries (as well as loyalty program statements) in order to update that User's travel plans on the timeline.

userName

string true

The logon name that User picked during registration

status

string true

User's status on AwardWallet. Possible values are:

  • Free
  • Plus

accessLevel

string false

Status of a User in the business account. Possible values are:

  • n/a
  • Regular
  • Booking Administrator
  • Administrator

connectionType

string true

User connection status. Possible values are:

  • Connected
  • Pending

Pending - is the status for those users who have not yet accepted an invitation to connect to the Business Account.

accountsAccessLevel

string true

Identifies the level of account access the User granted to the business. Possible values are:

0 - Read numbers

1 - Read balances

2 - Read all

3 - Full control

When inviting the users, you can pass one of these numbers as a value to the access GET parameter. This will determine the level of access you would be requesting by default. Keep in mind that users can change the level of access you have to their accounts at any time.

accountsSharedByDefault

boolean true

Identifies if the User is configured to share newly added accounts by default with the Business Account

editConnectionUrl

string true

URL address of the page where business administrator can manage the connection settings with this user.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts shared by the user with the business account.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this connected user.

bookingRequestsUrl

string false

URL address of the page where business administrator can see all the reward booking requests made by the user with the business.

Member

Parameter Type Required Description

memberId

integer true

Unique ID that identifies a given Member

fullName

string true

Full name of a Member

email

string false

Email address of a Member

forwardingEmail

string false

AwardWallet email address of a Member that can be used for forwarding Member itineraries (as well as loyalty program statements) in order to update that Member’s travel plans on the timeline.

editMemberUrl

string true

URL address of the page where business administrator can edit this member’s settings such as name or email address.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts that belong to this member.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this member.

Account

Parameter Type Required Description

accountId

integer true

Unique identifier of an Account

displayName

string true

Name of the provider to which the Account belongs to. This is a user-friendly name that shows both the name the company as well as the actual name of the loyalty program. I.e. British Airways (Executive Club)

kind

string true

Type of account provider. Possible values are:

  • Airlines
  • Hotels
  • Credit Cards
  • Shopping
  • Rentals
  • Dining
  • Trains
  • Cruises
  • Surveys
  • Other

login

string true

Account login value. Could be "n/a" if the value is empty.

autologinUrl

string true

The auto-login URL that will automatically log you into that account on the provider’s website. Auto-login is only available on the accounts that provided the Business Account with Full Control. If the Business Account doesn’t have Full Control this value will be set to "n/a".

updateUrl

string true

The URL where you can retrieve all account details from the prover’s website. Account updating is only available on the accounts that provided the Business Account with Full Control. If the Business Account doesn’t have Full Control this value will be set to "n/a".

editUrl

string true

The URL where you can change account details, such as username and password values. Changing accounts is only available on the accounts that provided the Business Account with Full Control. If the Business Account doesn’t have Full Control this value will be set to "n/a".

balance

string true

Current account balance presented as a formatted number

balanceRaw

number true

Current account balance

lastDetectedChange

string false

Last change in the account balance as detected by AwardWallet. This change may or may not correlate with the actual change in the history of the account on the provider’s website.

expirationDate

date-time false

The date when all or part of the account balance will expire. In most cases this date was calculated by AwardWallet.

barcode

string false

Zeros and ones representing the bar code of the account. If available, and drawn properly, can be used with the provider’s bar code readers.

owner

string true

Full name of the account owner. Keep in mind that a Connected User could share accounts of his or her family members. In that case that person would show up as the account owner.

errorCode

integer true

The result of the last account update. Possible values are:

0 - Account has never been updated

1 – Account was successfully updated

2 – Account has Invalid credentials

3 – Account is locked out

4 – The provider returned some error, or requires some user action

5 – The provider is disabled by AwardWallet

6 - AwardWallet failed to parse the provider’s web site for unknown reason

7 – Account password is missing

8 – Account is disabled to prevent lockouts on the prover’s website

9 – Account was successfully updated, but there is a warning message returned

10 – The user needs to answer a security question, to update this account

11 - Account updating timed out.

errorMessage

string false

Account error message as shown on the provider’s website.

lastChangeDate

date-time false

Last time AwardWallet detected a change in the account balance. This date will probably not correlate with the date last time account actually changed on the provider’s website.

lastRetrieveDate

date-time false

Last time AwardWallet successfully logged into the account and successfully retrieved the account information

history

array false

Whenever Account History is available it will be presented as a History array. Please note that all providers choose to show account history in different formats, so unfortunately there is no standard column definitions across all providers. If you need to work with Account History you would need to evaluate the History array on per provider basis.

properties

array false

Account properties are so called "secondary attributes" that we gather from providers' websites whenever possible. Each provider has a different set of these secondary properties. To standardize some of them, properties may have a kind value as described below.

subAccounts

array false

Some accounts have subaccounts. For example, a single Capital One account can have multiple credit cards with individual balances under each card. Those separate balances would be tracked as subaccounts under that Capital One account.

SubAccount

Parameter Type Required Description

subAccountId

integer true

Unique identifier of a sub-account

displayName

string true

User friendly name of a sub-account

balance

string true

Current sub-account balance presented as a formatted number

balanceRaw

number false

Current sub-account balance

lastDetectedChange

string false

Last change in the sub-account balance as detected by AwardWallet. This change may or may not correlate with the actual change in the history of that sub-account on the provider’s website.

properties

array false

Sub-account properties are so called "secondary attributes" that we gather from providers' websites whenever possible. Each provider has a different set of these secondary properties.

AccountProperty

Parameter Type Required Description

name

string true

Attribute name

value

string true

Attribute value

rank

integer false

Only used to provide a numeric representation of the elite status of an Account so that elite statuses could be standardized across all providers. It is only used for the Status property (Kind = 3)

kind

integer false

Used to standardize properties across different providers as they all may call conceptually the same attributes slightly differently. Possible values are:

  • 1 - Account number
  • 2 - Expiration
  • 3 - Status
  • 4 - Lifetime points
  • 5 - Member since
  • 6 - Expiring balance
  • 7 - YTD Miles/Points
  • 8 - YTD Segments
  • 9 - Next elite level
  • 10 - Miles/Points needed to next level
  • 11 - Segments needed to next level
  • 12 - Name
  • 13 - Last activity
  • 14 - Miles/Points needed for next reward
  • 15 - Status expiration
  • 16 - Miles/Points to retain status
  • 17 - Segments to retain status
  • 18 - Alliance elite level
  • 19 - Status miles/points

History

Account history row

Parameter Type Required Description

fields

array false

History fields

HistoryField

Account history field

Parameter Type Required Description

code

string true

There are 4 predefined field codes:

PostingDate - The date when miles or points were posted to the account

Description - Description of the transaction

Miles - Shows the numerical change in the miles or points

Bonus - Shows the bonus miles or points

For everything else this code value will be set to Info

name

string true

Human readable name of the attribute, such as "Transaction Date"

value

string true

Attribute value, such as "Finance Card - BA VISA NON BA SPEND"

Members

List Members

Response Example

                            
{
  "members": [
    {
      "memberId": 1234,
      "fullName": "John Smith",
      "email": "JSmith@email.com",
      "forwardingEmail": "BusinessABC.JSmith@AwardWallet.com",
      "editMemberUrl": "https://business.awardwallet.com/agent/editFamilyMember.php?ID=998877&Source=M",
      "accountListUrl": "https://business.awardwallet.com/account/list#/?agentId=998877",
      "timelineUrl": "https://business.awardwallet.com/timeline/?agentId=998877#/998877",
      "accountsIndex": [
        {
          "accountId": 12345,
          "lastChangeDate": "2016-07-20T17:17:17+00:00",
          "lastRetrieveDate": "2016-07-20T17:17:17+00:00"
        },
        {
          "accountId": 12346,
          "lastChangeDate": "2016-07-10T17:17:37+00:00",
          "lastRetrieveDate": "2016-07-22T17:17:37+00:00"
        }
      ]
    }
  ]
}
                            
                        

Members are just names you add under your business interface. They make your life easier when organizing stuff under your business interface. These members don’t have an AwardWallet account and therefore are not linked to your business account the same way as Connected Users are. You can use this method to retrieve all the members under your business account.

HTTP Request

GET https://business.awardwallet.com/api/export/v1/member

Response

Parameter Type Required Description

members

array true

array of MembersListItem

MembersListItem

Parameter Type Required Description

memberId

integer true

Unique ID that identifies a given Member

fullName

string true

Full name of a Member

email

string false

Email address of a Member

forwardingEmail

string false

AwardWallet email address of a Member that can be used for forwarding Member itineraries (as well as loyalty program statements) in order to update that Member’s travel plans on the timeline.

editMemberUrl

string true

URL address of the page where business administrator can edit this member’s settings such as name or email address.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts that belong to this member.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this member.

accountsIndex

array true

An index of all Member accounts that can be used to determine if calling the account/{id} is necessary for each account.

AccountsIndexItem

Parameter Type Required Description

accountId

integer true

Unique identifier of an Account

lastChangeDate

date-time true

Last time AwardWallet detected a change in the account balance. This date will probably not correlate with the date last time account actually changed on the provider’s website.

lastRetrieveDate

date-time false

Last time AwardWallet successfully logged into the account and successfully retrieved the account information

Get Member Details

Response Example

                            
{
  "memberId": 1234,
  "fullName": "John Smith",
  "email": "JSmith@email.com",
  "forwardingEmail": "BusinessABC.JSmith@AwardWallet.com",
  "editMemberUrl": "https://business.awardwallet.com/agent/editFamilyMember.php?ID=998877&Source=M",
  "accountListUrl": "https://business.awardwallet.com/account/list#/?agentId=998877",
  "timelineUrl": "https://business.awardwallet.com/timeline/?agentId=998877#/998877",
  "accounts": [
    {
      "accountId": 7654321,
      "displayName": "British Airways (Executive Club)",
      "kind": "Airlines",
      "login": "johnsmith",
      "autologinUrl": "https://business.awardwallet.com/account/redirect.php?ID=7654321",
      "updateUrl": "https://business.awardwallet.com/account/edit/7654321?autosubmit=1",
      "editUrl": "https://business.awardwallet.com/account/edit/7654321",
      "balance": "146,780",
      "balanceRaw": 146780,
      "owner": "John Smith",
      "errorCode": 1,
      "lastDetectedChange": "+750",
      "expirationDate": "2018-12-10T00:00:00+00:00",
      "lastRetrieveDate": "2016-01-15T00:00:00+00:00",
      "lastChangeDate": "2016-01-15T00:49:33+00:00",
      "properties": [
        {
          "name": "Next Elite Level",
          "value": "Bronze",
          "kind": 9
        },
        {
          "name": "Date of joining the club",
          "value": "20 Jun 2013",
          "kind": 5
        },
        {
          "name": "Lifetime Tier Points",
          "value": "35,000"
        },
        {
          "name": "Executive Club Tier Points",
          "value": "35,000"
        },
        {
          "name": "Card expiry date",
          "value": "31 Mar 2017"
        },
        {
          "name": "Membership year ends",
          "value": "08 Feb 2016"
        },
        {
          "name": "Last Activity",
          "value": "10-Dec-15",
          "kind": 13
        },
        {
          "name": "Name",
          "value": "Mr Smith",
          "kind": 12
        },
        {
          "name": "Level",
          "value": "Blue",
          "rank": 0,
          "kind": 3
        },
        {
          "name": "Membership no",
          "value": "1122334455",
          "kind": 1
        }
      ],
      "history": [
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "3/31/14"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "12/11/13"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Google Wallet"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Other Earning"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "+100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "9/30/12"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-1,042"
            }
          ]
        }
      ]
    }
  ]
}
                            
                        

Using a nemberId, received from the /member method you are able to retrieve all of the loyalty accounts that this member has, as well as other member-specific attributes, such as name and email of the member.

HTTP Request

GET https://business.awardwallet.com/api/export/v1/member/{id}

Query Parameters

Parameter Type Required Description
id integer true

memberId

Response

Parameter Type Required Description

memberId

integer true

Unique ID that identifies a given Member

fullName

string true

Full name of a Member

email

string false

Email address of a Member

forwardingEmail

string false

AwardWallet email address of a Member that can be used for forwarding Member itineraries (as well as loyalty program statements) in order to update that Member’s travel plans on the timeline.

editMemberUrl

string true

URL address of the page where business administrator can edit this member’s settings such as name or email address.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts that belong to this member.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this member.

accounts

array true

Array of Member accounts

Connected Users

List Connected Users

Response Example

                            
{
  "connectedUsers": [
    {
      "userId": 12345,
      "fullName": "John Smith",
      "status": "Free",
      "userName": "JSmith",
      "email": "JSmith@email.com",
      "forwardingEmail": "JSmith@AwardWallet.com",
      "accessLevel": "Regular",
      "connectionType": "Connected",
      "accountsAccessLevel": "Full control",
      "accountsSharedByDefault": true,
      "editConnectionUrl": "https://business.awardwallet.com/members/connection/112233",
      "accountListUrl": "https://business.awardwallet.com/account/list#/?agentId=112233",
      "timelineUrl": "https://business.awardwallet.com/timeline/?agentId=166765#/112233",
      "bookingRequestsUrl": "https://business.awardwallet.com/awardBooking/queue?user_filter=332211",
      "accountsIndex": [
        {
          "accountId": 12345,
          "lastChangeDate": "2016-07-20T17:17:17+00:00",
          "lastRetrieveDate": "2016-07-20T17:17:17+00:00"
        },
        {
          "accountId": 12346,
          "lastChangeDate": "2016-07-10T17:17:37+00:00",
          "lastRetrieveDate": "2016-07-22T17:17:37+00:00"
        }
      ]
    }
  ]
}
                            
                        

Connected Users are the users who have their own personal AwardWallet credentials who chose to connect their accounts to your business account. They can granularly choose what exactly they wish to share with you.

This method will list all such users as well as an index of the loyalty accounts that they own.

HTTP Request

GET https://business.awardwallet.com/api/export/v1/connectedUser

Response

Parameter Type Required Description

connectedUsers

array true

array of users

ConnectedUsersListItem

Parameter Type Required Description

userId

integer true

Unique ID that identifies a given User

fullName

string true

Full name that User provided during registration

email

string true

Email address of a User

forwardingEmail

string true

AwardWallet email address of a User that can be used for forwarding User itineraries (as well as loyalty program statements) in order to update that User's travel plans on the timeline.

userName

string true

The logon name that User picked during registration

status

string true

User's status on AwardWallet. Possible values are:

  • Free
  • Plus

accessLevel

string false

Status of a User in the business account. Possible values are:

  • n/a
  • Regular
  • Booking Administrator
  • Administrator

connectionType

string true

User connection status. Possible values are:

  • Connected
  • Pending

Pending - is the status for those users who have not yet accepted an invitation to connect to the Business Account.

accountsAccessLevel

string true

Identifies the level of account access the User granted to the business. Possible values are:

0 - Read numbers

1 - Read balances

2 - Read all

3 - Full control

When inviting the users, you can pass one of these numbers as a value to the access GET parameter. This will determine the level of access you would be requesting by default. Keep in mind that users can change the level of access you have to their accounts at any time.

accountsSharedByDefault

boolean true

Identifies if the User is configured to share newly added accounts by default with the Business Account

editConnectionUrl

string true

URL address of the page where business administrator can manage the connection settings with this user.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts shared by the user with the business account.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this connected user.

bookingRequestsUrl

string false

URL address of the page where business administrator can see all the reward booking requests made by the user with the business.

accountsIndex

array true

An index of all Member accounts that can be used to determine if calling the account/{id} is necessary for each account.

Get Connected User Details

Response Example

                            
{
  "userId": 12345,
  "fullName": "John Smith",
  "status": "Free",
  "userName": "JSmith",
  "email": "JSmith@email.com",
  "forwardingEmail": "JSmith@AwardWallet.com",
  "accessLevel": "Regular",
  "connectionType": "Connected",
  "accountsAccessLevel": "Full control",
  "accountsSharedByDefault": true,
  "editConnectionUrl": "https://business.awardwallet.com/members/connection/112233",
  "accountListUrl": "https://business.awardwallet.com/account/list#/?agentId=112233",
  "timelineUrl": "https://business.awardwallet.com/timeline/?agentId=166765#/112233",
  "bookingRequestsUrl": "https://business.awardwallet.com/awardBooking/queue?user_filter=332211",
  "accounts": [
    {
      "accountId": 7654321,
      "displayName": "British Airways (Executive Club)",
      "kind": "Airlines",
      "login": "johnsmith",
      "autologinUrl": "https://business.awardwallet.com/account/redirect.php?ID=7654321",
      "updateUrl": "https://business.awardwallet.com/account/edit/7654321?autosubmit=1",
      "editUrl": "https://business.awardwallet.com/account/edit/7654321",
      "balance": "146,780",
      "balanceRaw": 146780,
      "owner": "John Smith",
      "errorCode": 1,
      "lastDetectedChange": "+750",
      "expirationDate": "2018-12-10T00:00:00+00:00",
      "lastRetrieveDate": "2016-01-15T00:00:00+00:00",
      "lastChangeDate": "2016-01-15T00:49:33+00:00",
      "properties": [
        {
          "name": "Next Elite Level",
          "value": "Bronze",
          "kind": 9
        },
        {
          "name": "Date of joining the club",
          "value": "20 Jun 2013",
          "kind": 5
        },
        {
          "name": "Lifetime Tier Points",
          "value": "35,000"
        },
        {
          "name": "Executive Club Tier Points",
          "value": "35,000"
        },
        {
          "name": "Card expiry date",
          "value": "31 Mar 2017"
        },
        {
          "name": "Membership year ends",
          "value": "08 Feb 2016"
        },
        {
          "name": "Last Activity",
          "value": "10-Dec-15",
          "kind": 13
        },
        {
          "name": "Name",
          "value": "Mr Smith",
          "kind": 12
        },
        {
          "name": "Level",
          "value": "Blue",
          "rank": 0,
          "kind": 3
        },
        {
          "name": "Membership no",
          "value": "1122334455",
          "kind": 1
        }
      ],
      "history": [
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "3/31/14"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "12/11/13"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Google Wallet"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Other Earning"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "+100"
            }
          ]
        },
        {
          "fields": [
            {
              "name": "Transaction Date",
              "code": "PostingDate",
              "value": "9/30/12"
            },
            {
              "name": "Description",
              "code": "Description",
              "value": "Expired Points"
            },
            {
              "name": "Type",
              "code": "Info",
              "value": "Adjustments"
            },
            {
              "name": "Points",
              "code": "Miles",
              "value": "-1,042"
            }
          ]
        }
      ]
    }
  ]
}
                            
                        

Using a userId, received from the /connectedUser method you are able to retrieve all of the loyalty accounts that this user has shared with your business account, as well as other user-specific attributes, such as their name, email, level of access they provided you with, etc.

HTTP Request

GET https://business.awardwallet.com/api/export/v1/connectedUser/{id}

Query Parameters

Parameter Type Required Description
id integer true

userId

Response

Parameter Type Required Description

userId

integer true

Unique ID that identifies a given User

fullName

string true

Full name that User provided during registration

email

string true

Email address of a User

forwardingEmail

string true

AwardWallet email address of a User that can be used for forwarding User itineraries (as well as loyalty program statements) in order to update that User's travel plans on the timeline.

userName

string true

The logon name that User picked during registration

status

string true

User's status on AwardWallet. Possible values are:

  • Free
  • Plus

accessLevel

string false

Status of a User in the business account. Possible values are:

  • n/a
  • Regular
  • Booking Administrator
  • Administrator

connectionType

string true

User connection status. Possible values are:

  • Connected
  • Pending

Pending - is the status for those users who have not yet accepted an invitation to connect to the Business Account.

accountsAccessLevel

string true

Identifies the level of account access the User granted to the business. Possible values are:

0 - Read numbers

1 - Read balances

2 - Read all

3 - Full control

When inviting the users, you can pass one of these numbers as a value to the access GET parameter. This will determine the level of access you would be requesting by default. Keep in mind that users can change the level of access you have to their accounts at any time.

accountsSharedByDefault

boolean true

Identifies if the User is configured to share newly added accounts by default with the Business Account

editConnectionUrl

string true

URL address of the page where business administrator can manage the connection settings with this user.

accountListUrl

string true

URL address of the page where business administrator can see all of the loyalty accounts shared by the user with the business account.

timelineUrl

string true

URL address of the page where business administrator can see the travel timeline (i.e. all of their travel reservations) of this connected user.

bookingRequestsUrl

string false

URL address of the page where business administrator can see all the reward booking requests made by the user with the business.

accounts

array true

Array of accounts the User has shared with the Business Account. It includes all account details as described below, except the array of History items is limited to the first 10 records.

Errors

Error Code Meaning
400 Bad Request
401 Unauthorized – Your API key is wrong
403 Forbidden
404 Not Found
405 Method Not Allowed – You tried to access an API with an invalid method
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable