Introdução

A API PNA Cobrand LATAM Pass é a forma pela qual nossas parcerias bancárias gerenciam o ciclo de vida dos benefícios entregues aos nossos associados LATAM Pass que possuem um cartão cobrand.

O início do ciclo de vida ocorre quando um novo cartão é aprovado ou um cartão atual é desbloqueado, ou seja, quando os benefícios LATAM Pass devem ser entregues ao associado.

Importante: Um código de status 200 não significa que o cartão foi ativado com sucesso. O resultado final pode ser consultado 24 horas após a criação do processamento, utilizando o correlationId obtido na resposta.

Para realizar requisições à API, primeiro é necessário obter o token de acesso. Consulte a documentação Autenticação para obter todas as informações.

Cronograma base (Carta Gantt)

Acesse o cronograma base para cada tipo de parceria com o programa utilizando os seguintes links:

1. Novas parcerias;
2. Parcerias existentes migrando para a API PNA LATAM Pass.

Fluxo do processo

Requisição

Cabeçalhos

Corpo (Body)

CobrandedLifeCycleRequest

Member

Os campos marcados com (*) podem ser obrigatórios ou não conforme a configuração do banco emissor do cartão. Consulte o ponto focal comercial da LATAM Pass sobre os campos requeridos para sua integração.

Document

Phone

Se o objeto phone for enviado, os campos countryCode e phoneNumber são obrigatórios.

Card

Os campos marcados com (*) podem ser obrigatórios ou não conforme a configuração do banco emissor do cartão.

Exemplo de requisição

Pode variar dependendo das configurações do banco emissor

{
  "member": {
    "ffn": "12345654321",
    "firstName": "Carlos Jose",
    "lastName": "Silva Santos",
    "birthDate": "1980-12-31",
    "gender": "MALE",
    "email": "carlos.santos@email.com",
    "residenceCountryCode": "BR",
    "document": {
      "documentId": "68245775886",
      "documentType": "CPF",
      "issueCountryCode": "BR"
    },
    "phone": {
      "countryCode": 55,
      "areaCode": 11,
      "phoneNumber": 999998888
    }
  },
  "card": {
    "brand": "VISA",
    "category": "PLATINUM",
    "lastFour": 1234,
    "approvedAt": "2026-06-15T22:06:11.201Z",
    "tier": 1
  }
}

Resposta

200 — Requisição recebida

Um código 200 indica que a requisição foi recebida e o processamento foi criado. Não garante que o cartão foi ativado. O resultado final deve ser consultado com o correlationId através do endpoint de consulta de status.

CobrandedLifeCycleResponse

MemberSimplified

Trace

{
  "member": {
    "ffn": "68245775886"
  },
  "trace": {
    "correlationId": "96bd0750-71e0-4ed6-9489-96ddfd0e34cd",
    "threadId": "c0fead84-234d-4fb2-a865-b070f77ec086",
    "receivedDateTime": "2023-10-05T12:53:00Z",
    "returnedDateTime": "2023-10-05T12:53:24Z"
  }
}

Erros mais comuns

400 — Campos inválidos ou ausentes

Retornado quando campos obrigatórios estão ausentes ou os valores enviados não são válidos. O campo details indica o campo específico e o motivo.

{
  "code": 1,
  "message": "Invalid request content",
  "instructions": "Evaluate the request fields",
  "issuedDateTime": "2024-10-01T00:00:00Z",
  "details": {
    "member.ffn": "must not be null"
  }
}

429 — Limite de requisições excedido

{
  "code": 429,
  "message": "Current rate exceeds the maximum for internal integrations",
  "instructions": "Please, try again later",
  "issuedDateTime": "2024-10-01T00:00:00Z",
  "details": null
}

500 — Erro interno do servidor

{
  "code": 33,
  "message": "Internal server error",
  "instructions": "Retry the request later. If the problem persists, contact LATAM Pass support with the correlationId.",
  "issuedDateTime": "2023-10-05T12:53:10Z",
  "details": {
    "correlationId": "96bd0750-71e0-4ed6-9489-96ddfd0e34cd"
  }
}

Estrutura de ErrorException

Documentação técnica

Clique aqui para acessar a especificação técnica completa (Swagger).