O conteúdo desta página foi extraído na íntegra de Enviar acúmulo de pontos | Desenvolvedores | LATAM Pass.

Enviar acúmulo de pontos

POST

O exemplo abaixo contém os campos mínimos obrigatórios para realização de um acúmulo de pontos. Vide link a seguir para detalhes completo da interface: Swagger Create Accrual POST.

Segue abaixo CURL de exemplo:

curl
--location 'https://api.latampass.com/sandbox/v1/customer/loyalty/partner/accrual' \\
--header 'client\_id: xxxxx' \\
--header 'access\_token: xxxxx' \\
--header 'Content-Type: application/json' \\
--data-raw '{
    "accrual": {
        "partner": {
            "id": "02012862000160"
        },
        "member": {
            "ffn": "93558173040",
            "email": "Bridie26@yahoo.com"
        },
        "partnerAccrualId": "1db32086-d5ab-448c-b532-1f9e6d1328a0",
        "partnerTransactionId": "39b347d9-aafb-44af-8293-83bb45562c2b",
        "partnerOriginDate": "2023-07-26T21:15:53.547Z",
        "description": "Explicabo sit est quos qui expedita.",
        "points": 6000,
        "productId": "001"
    },
    "interfaceId": 3
}'

Explicação funcional de cada campo

  • partner.id → id de cadastro do parceiro no sistema da Latam Pass. Esse conteúdo é fornecido pelo time comercial da Latam Pass.
  • member.ffn → Frequent Flyer Number ou número de passageiro frequente. No BR, é o mesmo do CPF. No CL, é o mesmo do RUT.
  • member.email → e-mail do sócio
  • partnerAccrualId → ID sistêmico do parceiro. Pode enviar um ID de controle interno. Limite 50 caracteres.
  • partnerTransactionId → ID utilizado para faturamento. Esse dado é chave para conciliação financeira e pode ser o mesmo ID enviado no campo partnerAccrualId. O mais importante é que o parceiro tenha controle desse campo para realização da conciliação financeira quando a Latam Pass gerar a fatura para pagamento. Limite 50 caracteres.
  • partnerOriginDate → data e hora de solicitação do acúmulo no sistema do parceiro, correspondente à data e hora da atividade do cliente com o parceiro.
  • description → campo livre. Sugestão de envio: Acúmulo de pontos do produto XYZ.
  • points → quantidade de pontos para acumular.
  • productId → ID de cadastro do produto vinculado ao partner.id. Esse conteúdo é fornecido pelo time comercial da Latam Pass.
  • interfaceId → fixo 3.

Em um caso de sucesso, receberá o seguinte retorno JSON.

{
    "correlationId": "1ad7b022-47b7-4ca4-8220-432a0b258173",
    "id": 32,
    "partnerAccrualId": "6d3e64ea-e616-474c-8a4c-37fde027bdff",
    "partnerTransactionId": "50e24c15-3782-4963-acca-af58f330df2b",
    "receivedAt": "2022-06-30 16:19:06.835-0300"
}

Utilizamos sempre o ID e o correlationId para realizar análise de todo o fluxo de acúmulo. Importante salvar o ID retornado acima pois ele é um comprovante de aceite do lado LatamPass.


Regra de duplicidade

Os acúmulos possuem dados obrigatórios e alguns deles são usados na validação de duplicidade.

Abaixo está o conjunto de dados usados neste processo:

  • ffn
  • partner_id
  • partner_transaction_id
  • partner_origin_date
  • points

Caso seja encontrado uma transação em nosso BD com os mesmos dados, ela será apontada como duplicidade na resposta do request, caso negativo a transação continua o fluxo de processamento.

Este ponto é importante pois caso ocorra envio com um dos dados diferentes, será considerado uma nova transação.


Envio de datas

Os acúmulos são creditados usando a data enviada pelo parceiro e ela é usada como parâmetro para qualquer ação que dependa de datas. Exemplo: caso tenhamos uma campanha para bonificação de pontos, a data para validar se é elegível ao bônus é a data recebida pelo parceiro (data original da solicitação de acúmulo).

Neste sentido solicitamos que sejam enviadas as datas conforme os exemplos abaixo:

O envio de data deve ser feita no padrão ISO-8601, sendo neste padrão conseguimos preservar o timezone.

FORMATO CORRETO DE ENVIO

Com Timezone: '1997-07-16T19:20:30-03:00'

Este ponto não é um impeditivo para o acúmulo, sendo assim, caso a data seja enviada sem o timezone nós seguiremos as regras internas de conversão.


Collection Postman

O link a seguir contém o projeto Postman para testes em Sandbox. 

Accrual PNA - Postman