Introdução

A API PNA Accrual LATAM Pass é a forma pela qual os nossos parceiros fazem a gestão do acúmulo não aéreo que é entregue aos clientes LATAM Pass correspondente ao acordo comercial entre as partes.

Após Solicitar acúmulo, os parceiros realizam a consulta do acúmulo de forma a obter o estado de seu processamento, por ser assíncrono.

Para poder realizar requisições à API, deve-se primeiro obter o token de acesso. Consulte a documentação Autenticação para todas as informações.

Consultar acúmulo

Cronograma base

Acesse por meio dos itens abaixo o cronograma base de cada tipo de parceria do programa:

Requisição

Utiliza-se, obrigatoriamente, a identificação do parceiro (partnerIdentifier) para consultar o acúmulo. Além deste, um dos filtros abaixo deve ser utilizado, todos trafegados quando o acúmulo foi solicitado:

Código de identificação do correlativo indicado pelo parceiro ou, se não indicado, gerado pelo LATAM Pass para efeitos de rastreabilidade (correlationId)
Código de identificação da transação do lado do parceiro (partnerTransactionId)
Código de identificação da transação do lado do parceiro para efeitos de conciliação do faturamento (partnerAccrualId)

Diretriz

A seguinte diretriz deve ser seguida, considerando-a como tempos mínimos, quando do envio das requisições para consultar o acúmulo (o 'Estado final' foi calculado com base nas transações recebidas entre 01Jan24 e 10Mai24):

Tentativa	Depois da solicitação	Depois da última consulta	Estado final (~)
1ª	15"	-	93,0%
2ª	30"	15"	93,5%
3ª	60"	30"	94,0%
4+	-	60"	100,0%

Cabeçalho

client_id: valor obtido a partir do menu API Tools > Minhas Apps > Client ID e obrigatório em todas as requisições
access_token: token de acesso obtido anteriormente
x-latam-test: fixo LatamPass, a ser utilizado apenas em ambiente de teste, ou seja, não deve ser utilizado em ambiente de produção

Resposta

Os seguintes estados fazem parte da resposta da consulta do acúmulo:

Estados:
- Intermediário (definido assim que a transação é recebida do parceiro):
  - PROCESSING: solicitação em processamento.
- Finais (definidos quando do término do processamento da transação):
  - CANCELLED: solicitação rejeitada. O acúmulo solicitado não foi contabilizado na conta do cliente para composição de seu saldo. Este é o único estado a ser considerado para estorno da transação do lado do parceiro;
  - PROCESSED: acúmulo concedido. O acúmulo solicitado foi contabilizado na conta do cliente para composição de seu saldo e fará parte do próximo arquivo de faturamento.

Motivos para uma solicitação ser rejeitada

Motivo	Código	Mensagem	Instruções ao parceiro
A data da atividade junto ao parceiro, no momento do solicitação de acúmulo, encontrava-se no futuro. (`partnerOriginalDateTime`)	101	ActivityDateGreater ThanCurrentDate	Validate your request because some date is greater than current date
Código de identificação do parceiro não cadastrado. (`partnerId`)	108	PartnerDoesNotExist	Partner doesn't exist. Please contact our LATAM team to set up the necessary configurations
Código de identificação do produto não cadastrado ou não vinculado ao parceiro ou expirado no momento da solicitação de acúmulo. (`productId`)	110	IACOD	Accrual code is expired or invalid
Programa inválido para o país de residência do cliente. (`ffn`)	111	CCIE - Invalid country of residence	Invalid program. Please contact our LATAM team to set up the necessary configurations
Cliente não encontrado com os dados informados (`ffn`,`document`), mas endereço de e-mail vinculado à outra conta já existente (`email`).	112	DuplicateMemberProfiles ExistsAsPerAlgorithm	Member: Contact LATAM to update your data
Código de identificação do cliente (`ffn`) é inválido para o seu país de residência (`residenceCountryCode`).	113	Incorrect CPF format validated by the Core System	Fix the CPF number
Cliente com estado de conta inválido para acúmulo. (`ffn`)	114	Invalid member status	Member: Contact LATAM to update your data
Não foi possível processar a solicitação de acúmulo para o cliente. (`ffn`,`document`)	204	Member already exists	Member: Contact LATAM to update your data
Código de identificação do cliente (`ffn`) é inválido para o seu país de residência (`residenceCountryCode`).	205	Incorrect CPF format validated by the Core System	Fix the CPF number
Não foi possível processar a solicitação de acúmulo para o cliente. (`ffn`,`document`)	206	Member already exists	Member: Contact LATAM to update your data

Erros mais comuns

`partnerIdentifier` não informado

{
  "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` não informado

{
    "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"
}

Solicitação de acúmulo não encontrada

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

Documentação técnica

Clique aqui para acessá-la.

Consultar acúmulo (v2)