Introduction

The PNA Cobrand LATAM Pass API is the way our banking partners manage the lifecycle of benefits delivered to our LATAM Pass members who hold a cobrand card.

The start of the lifecycle occurs when a new card is approved or a current card is unblocked, meaning when LATAM Pass benefits must be delivered to the member.

Important: A status code 200 does not mean the card was successfully activated. The final result can be queried 24 hours after the processing was created, using the correlationId obtained in the response.

To make requests to the API, you must first obtain an access token. See the Authentication documentation for all the information.

Base Gantt chart

Access the base Gantt chart for each type of program partnership using the following links:

1. New partnerships;
2. Existing partnerships migrating to the PNA LATAM Pass API.

Process flow

Request

Headers

Body

CobrandedLifeCycleRequest

Member

Fields marked with (*) may or may not be required depending on the configuration of the card-issuing bank. Check with the LATAM Pass commercial focal point for the fields required for your integration.

Document

Phone

If the phone object is sent, the countryCode and phoneNumber fields are required.

Card

Fields marked with (*) may or may not be required depending on the configuration of the card-issuing bank.

Request example

May vary depending on the issuing bank's configuration

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

Response

200 — Request received

A 200 code indicates that the request was received and processing was created. It does not guarantee that the card has been activated. The final result must be queried with the correlationId through the status query endpoint.

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

Most common errors

400 — Invalid or missing fields

Returned when required fields are missing or the values sent are not valid. The details field indicates the specific field and the reason.

{
  "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 — Request limit exceeded

{
  "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 — Internal server error

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

ErrorException structure

Technical documentation

Click here to access the complete technical specification (Swagger).