Introduction

The LATAM Pass Accrual PNA API is the way through which our partners manage non-air accumulation granted to LATAM Pass members according to the commercial agreement between the parties.

LATAM Pass members interact with our partners, for example, by purchasing products or contracting services. Once has expired the period in which the interaction can be partially or fully reversed (e.g., returning a purchased product or cancelling a contracted service), partners can submit an accrual request. That period must be respected because cancelling an accrual is not allowed.

To make requests to the API, you must first obtain an access token. Refer to the Authentication documentation for full information.

Baseline Gantt chart

Access the baseline Gantt chart for each type of program partnership through the links below:

  1. New partnerships;
  2. Existing partnerships migrating to the LATAM Pass PNA API.

Request

There are three ways to submit an accrual request:

  1. Using only the LATAM Pass member identification code or Frequent Flyer Number (ffn);
  2. Using only the member's identification document data (document);
  3. Using both ffn and document.

In the last case, if no LATAM Pass member is found with the provided ffn, the document data will be used to process the accrual request.

Headers

  • client_id: value obtained from the Dev Tools > My Apps > Client ID menu, and mandatory for all requests
  • access_token: access token previously obtained
  • x-latam-test: fixed LatamPass, to be used in the test environment only, which means, it must not be used in the production environment

Response

The response serves as acknowledgment that the API:

  1. Received the accrual request;
  2. Started processing it, which is asynchronous;
  3. Provided necessary data for Accrual notification or for partners to Get accrual.

Therefore, it is not recommended to design the user experience such that the member waits for the accrual request result during processing. Instead, the partner should inform the member that the request was successfully submitted, offering an opportunity to check the final status once processing is completed.

Based on transactions received between Jan 1st, 2024 and May 10th, 2024, 88% are processed within 6 seconds, with nearly ¾ completed within 4 seconds and almost half within 3 seconds.

Common errors

httpStatus 5xx Server Error

If the response to the accrual request is accompanied by a Server Error, i.e. an httpStatus 5xx, the same accrual must be requested again, that is, with the same data as the previous request.

There is no need to get it beforehand and it will not be notified, since the request in this condition was not even registered by the LATAM Pass Accrual PNA API.

Missing required fields or invalid values

{
  "message": "Request payload has problems with validation",
  "code": 99,
  "instructions": null,
  "details": {
    "nonAirAccrual.partner": "must not be null",
    "nonAirAccrual.quantity": "must not be null"
  },
  "issueDateTime": "2024-11-27T21:19:15.282436798Z"
}

Duplicate correlationId or other unique fields

{
  "correlationId": "24697ee0-2719-4f81-becf-34b3568c43a7",
  "httpStatus": "BAD_REQUEST",
  "code": 8,
  "instructions": "Verify if one or more unique fields were sent twice.",
  "issueDateTime": "2024-11-27T21:21:26.315632490Z"
}

Technical documentation

Click here to access it.