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.

After requesting accrual, partners get it in order to obtain the status of its processing, as it is asynchronous.

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:

Request

To get the accrual, you must use the partner identification (partnerIdentifier). In addition, you can use one the following filter, all tracked when the accrual was requested:

Correlation identifier code indicated by the partner or, failing that, generated by LATAM Pass for traceability purposes (correlationId)
Transaction identification code from the partner side (partnerTransactionId)
Transaction identification code from the partner side for billing reconciliation purposes (partnerAccrualId)

Guideline

The following guideline should be followed, considering it as minimum times, when sending requests to get the accrual (the 'Final status' was calculated based on transactions received between Jan 1st, 2024 and May 10th, 2024):

Attempt	After request	After last get	Final status(~)
1º	15"	-	93.0%
2º	30"	15"	93.5%
3º	60"	30"	94.0%
4+	-	60"	100.0%

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 following status are part of the accrual response:

Status:
- Intermediate (defined as soon as the transaction is received from the partner):
  - PROCESSING: request in processing.
- Final (defined when transaction processing is complete):
  - CANCELLED: rejected request. The requested accrual was not credited to the member's account for balance composition. This is the only status to be considered for transaction reversal on the partner side;
  - PROCESSED: granted accrual. The requested accrual was credited to the member's account for balance composition and it will be part of the next billing file.

Reasons for a request to be rejected

Reason	Code	Message	Instructions to Partner
The activity date with the partner, at the time of the accrual request, was in the future. (`partnerOriginalDateTime`)	101	ActivityDateGreater ThanCurrentDate	Validate your request because some date is greater than current date
Partner identification code not registered. (`partnerId`)	108	PartnerDoesNotExist	Partner doesn't exist. Please contact our LATAM team to set up the necessary configurations.
Product identification code not registered or not linked to the partner or expired at the time of accrual request. (`productId`)	110	IACOD	Accrual code is expired or invalid
Invalid program for the member's country of residence. (`ffn`)	111	CCIE - Invalid country of residence	Invalid program. Please contact our LATAM team to set up the necessary configurations.
Member not found with the informed data (`ffn`,`document`), but e-mail address associated to another account that already exists (`email`).	112	DuplicateMemberProfiles ExistsAsPerAlgorithm	Member: Contact LATAM to update your data
Member identification code (`ffn`) is invalid for their country of residence (`residenceCountryCode`).	113	Incorrect CPF format validated by the Core System	Fix the CPF number
Member with an invalid account status for accrual. (`ffn`)	114	Invalid member status	Member: Contact LATAM to update your data
Unable to process accrual request for the member. (`ffn`,`document`)	204	Member already exists	Member: Contact LATAM to update your data
Member identification code (`ffn`) is invalid for their country of residence (`residenceCountryCode`).	205	Incorrect CPF format validated by the Core System	Fix the CPF number
Unable to process accrual request for the member. (`ffn`,`document`)	206	Member already exists	Member: Contact LATAM to update your data

Common errors

`partnerIdentifier` not informed

{
  "correlationId": "9630db93-1e20-4736-ad4c-d939635db91f",
  "httpStatus": "BAD_REQUEST",
  "code": 99,
  "instructions": "PartnerIdentifier is Null or Empty",
  "issueDateTime": "2024-11-27T21:05:16.260318404Z"
}

`correlationId`, `partner_transactionId` ou `partnerAccrualId` not informed

{
    "correlationId": "1334f9f1-cc70-4469-937a-fd46e4df0a62",
    "httpStatus": "BAD_REQUEST",
    "code": 99,
    "message": "Request payload has problems with validation",
    "instructions": "Other filters is null or empty, please provide at least
one filter - partnerAccrualId, partnerTransactionId or correlationId",
    "issueDateTime": "2024-11-27T21:05:16.260318404Z"
}

Accrual request not found

{
    "httpStatus": "NOT_FOUND",
    "code": 11,
    "message": "No accrual found in this request",
    "instructions": "Verify the provided parameters",
    "issueDateTime": "2024-10-31T21:41:13.168947164Z"
}

Technical documentation

Click here to access it.