Join Programme API Documentation

The Join Programme endpoint creates a new account within a loyalty programme, registers the member’s security credentials (if provided) and associates the member with the partner or partner programme.

Firstly, the member details and username are checked to ascertain if they are pre-existing within the Loyalty platform. Processing of the request will occur if the member and username do not exist. Successful processing of a request will create a loyalty account and associate the security profile with this new account, if it has been provided.

The member details along with membership number are returned to the consumer as a successful response, however if the request fails an appropriate error message is returned.

Business Context

The process relating to the consumption of the Join Programme endpoint is illustrated in the following swim-lanes diagram:

• A member wishing to join a partner’s programme accesses a form within the partner channel
• The member details are entered into the form, including the security profile information
• The member details are then passed to the Join Programme endpoint
• The request is validated
• The provided username is checked for uniqueness. If unique, the service continues to process the request, otherwise an appropriate error is returned
• The Join Programme endpoint checks the member details and ensures that the member has not previously joined
• Upon successful processing of the new member details, member details and membership number are returned to the partner as part of the successful response
• If the request fails, an appropriate error message is returned in the response

Technical Context

The Join Programme endpoint is an independent service and does not rely on any other service having been called. To invoke the Join Programme endpoint the partner must have previously been issued with a valid API key. The following steps are performed by the Join Programme endpoint:

• Validate input request
• Standardise postal address in request
• Persist member information in the system
• Return member information as successful response

Important Technical Notes

This endpoint can receive upper or lower case ASCII or accented data but this will be converted to upper case ASCII on receipt by the Join Programme endpoint. The response message will contain only upper case ASCII characters.

This endpoint provides functionality to create a new account with the minimal dataset of First Name, Last Name and Email Address of a member.

This endpoint supports accented characters as input in First Name, Middle Initial, Last Name, Address Lines and Security Question Responses but converts them into equivalent uppercase ASCII character before validating the data and persisting data into the systems. Please refer to Appendix G for further details.

Telephone numbers are supplied as separate area code and number fields in the request but are returned as a single combined field in the response.

Pre-conditions

• The partner must have a valid API key to access the Join Programme endpoint.

Post-conditions

Success outcome: Member information along with account details are returned.

Error outcome: Service error is returned.

Service Details

URI Parameters

Production Endpoint:

POST https://api.avios.com/{version}/memberships?api_key={api_key}

Example

https://api.avios.com/v3/memberships?api_key=abcdef

Request Headers

Request Elements

The elements that make up the request message are detailed in the following table. These elements represent the data required to describe a new member within the loyalty programme. The following rules apply to request elements:

• This endpoint can receive accented characters, upper or lower case ASCII name, address and security response data, however this will be converted to upper case ASCII.
• The response message will contain only upper case ASCII characters.

Example Requests:

{
  "member": {
    "person": {
      "name": {
        "firstName": "MARK",
...Show more

Response Elements

The elements that make up the response message are detailed in the following table. The following rules apply to response elements:

• Response elements will always be returned in upper case ASCII characters.
• Element names are shown here using the upper camel case convention, for a JSON response the lower camel case convention is supported

Example response from the Member Registration endpoint with minimal data (only join)

{
  "membershipIdentifier": "3081471024602111",
  "membershipStatus": "ACTIVE",
  "member": {
    "person": {
...Show more

Example response from the Join Programme endpoint with security profile

{
  "person": {
    "name": {
      "title": "MR",
      "firstName": "WERTYHAA",
...Show more

Exception Message Elements

The exception message responses may be formatted in either upper or lower case.

Example of an error response

{
  "code": "LOYALTY_MEMBER_ALREADY_EXISTS",
  "businessMessage": "Loyalty member already exists",
  "developerMessage": "Loyalty member already exists",
  "developerLink": "https://developer.iagloyalty.com/docs",
...Show more

Error Codes

The table below shows a full list of error codes. If an error is received, then no account will have been created.