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.

A consulta de status permite obter o resultado final de uma operação assíncrona do ciclo de vida (create, delete, upgrade ou downgrade), identificada pelo correlationId retornado na resposta de cada uma dessas operações.

Importante: O status final da operação está disponível 24 horas após o envio da solicitação original. Consultas realizadas antes desse período podem não refletir o resultado definitivo.

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.

Requisição

Propriedade	Valor
Método	`GET`
Caminho	`/v1/customer/loyalty/partner/cobranded`

Cabeçalhos

Nome	Valor	Descrição	Tipo	Obrigatório
`x-issue-bank`	`<código do banco>`	Identificação do banco emissor do cartão	String	Sim
`client_id`	`<your_client_id>`	Valor obtido no menu Dev Tools > Meus Apps > Client ID	String	Sim
`access_token`	`<access_token>`	Token de acesso obtido durante a autenticação	String	Sim
`x-latam-test`	`LatamPass`	Apenas para uso no ambiente de sandbox. Não deve ser enviado em produção	String	Não

Parâmetros de consulta (Query Params)

Nome	Valor	Descrição	Tipo	Obrigatório
`correlationId`	`<correlation_id>`	ID de correlação recebido na resposta das operações create, delete, upgrade ou downgrade	String	Sim

Exemplo de requisição

GET /v1/customer/loyalty/partner/cobranded?correlationId=96bd0750-71e0-4ed6-9489-96ddfd0e34cd

Resposta

200 — Status encontrado

Retorna o status de processamento da operação identificada pelo correlationId. O campo cards contém 1 entrada para operações create ou delete, e 2 entradas para upgrade ou downgrade (cartão antigo cancelado + novo cartão ativado).

ConsultStatusResponse

Campo	Tipo	Descrição
`trace`	objeto (TraceConsult)	Informações de rastreabilidade e datas da operação
`member`	objeto (Member)	Informações do associado LATAM Pass
`cards`	lista de (Card)	Cartões afetados pela operação. 1 entrada (create/delete) ou 2 (upgrade/downgrade)

TraceConsult

Campo	Tipo	Descrição
`correlationId`	string	Identificador de correlação entre recursos da API LATAM eFFP
`approvedAt`	string	Data e hora em que a operação foi aprovada
`createdAt`	string	Data e hora em que o registro foi criado

Member

Campo	Tipo	Descrição
`ffn`	string	Número do associado

Card

Campo	Tipo	Descrição
`brand`	string (enum)	Bandeira do cartão: `AMEX`, `MASTERCARD`, `VISA`
`category`	string	Categoria do cartão
`tier`	integer	Nível de categoria do cartão
`cardStatus`	string (enum)	Operação realizada no cartão: `ACTIVE` (create), `CANCELLED` (delete), `UPGRADE` (upgrade), `DOWNGRADE` (downgrade)
`status`	string (enum)	Status da transação: `RECEIVED`, `PROCESSED`, `ERROR`, `MEMBER_NOT_EXIST`
`error`	string	Detalhe do erro. Presente apenas quando `status` é `ERROR`

Exemplo de resposta — 200

{
  "trace": {
    "correlationId": "96bd0750-71e0-4ed6-9489-96ddfd0e34cd",
    "approvedAt": "2026-06-29T12:53:00Z",
    "createdAt": "2026-06-29T12:50:00Z"
  },
  "member": {
    "ffn": "68245775886"
  },
  "cards": [
    {
      "brand": "MASTERCARD",
      "category": "PLATINUM",
      "cardStatus": "ACTIVE",
      "status": "RECEIVED",
      "error": ""
    }
  ]
}

Erros mais comuns

`correlationId` inválido ou ausente

{
	"code": 400,
	"message": "Invalid request data!",
	"instructions": "Correct request data before requesting it again.",
	"issuedDateTime": "2026-08-14",
	"details": {
		"correlationId": "must not be blank"
	}
}

Erro interno do servidor

Diante deste erro, recomenda-se tentar novamente a requisição. Se persistir, entre em contato com o suporte da LATAM Pass com o correlationId.

{
  "code": 500,
  "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

Campo	Tipo	Descrição
`code`	integer (int32)	Código interno da API LATAM eFFP
`message`	string	Descrição da mensagem de erro
`instructions`	string	Instruções para resolver o erro
`issuedDateTime`	string	Data e hora em que o erro foi gerado
`details`	map<string, object>	Par chave-valor com detalhes adicionais do erro

Documentação técnica

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