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 status query allows you to obtain the final result of an asynchronous lifecycle operation (create, delete, upgrade, or downgrade), identified by the correlationId returned in the response of each of those operations.

Important: The final status of the operation is available 24 hours after sending the original request. Queries made before that period may not reflect the definitive result.

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


Request

PropertyValue
MethodGET
Path/v1/customer/loyalty/partner/cobranded

Headers

NameValueDescriptionTypeRequired
x-issue-bank<bank code>Identification of the card-issuing bankStringYes
client_id<your_client_id>Value obtained from the Dev Tools > My Apps > Client ID menuStringYes
access_token<access_token>Access token obtained during authenticationStringYes
x-latam-testLatamPassFor use in the sandbox environment only. Must not be sent in productionStringNo

Query Parameters

NameValueDescriptionTypeRequired
correlationId<correlation_id>Correlation ID received in the response of create, delete, upgrade, or downgrade operationsStringYes

Request example

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

Response

200 — Status found

Returns the processing status of the operation identified by the correlationId. The cards field contains 1 entry for create or delete operations, and 2 entries for upgrade or downgrade (old card cancelled + new card activated).

ConsultStatusResponse

FieldTypeDescription
traceobject (TraceConsult)Traceability information and operation dates
memberobject (Member)LATAM Pass member information
cardslist of (Card)Cards affected by the operation. 1 entry (create/delete) or 2 (upgrade/downgrade)

TraceConsult

FieldTypeDescription
correlationIdstringCorrelation identifier between LATAM eFFP API resources
approvedAtstringDate and time the operation was approved
createdAtstringDate and time the record was created

Member

FieldTypeDescription
ffnstringMember number

Card

FieldTypeDescription
brandstring (enum)Card brand: AMEX, MASTERCARD, VISA
categorystringCard category
tierintegerCard category level
cardStatusstring (enum)Operation performed on the card: ACTIVE (create), CANCELLED (delete), UPGRADE (upgrade), DOWNGRADE (downgrade)
statusstring (enum)See Transaccion Status Table
errorstringError detail. Only present when status is ERROR

Transaction Status

StatusTypeDescription
RECEIVEDInitialA card activation request was received and persisted, pending processing.
CANCELLINGInitialA card cancellation request was received and is being processed.
RETRIEVED_SEGMENTSIntermediateThe member's segments were successfully fetched from the loyalty program.
INSERTED_GROUP_SEGMENTSIntermediate — ActivationThe cobranded group segments were inserted into the member's profile.
REMOVED_GROUP_SEGMENTSIntermediate — CancellationThe cobranded group segments were removed from the member's profile.
SECONDARY_FFN_RETRIEVEDIntermediateThe member's secondary frequent flyer number (FFN) was resolved, and the record was re-queued under it.
MEMBER_NOT_EXISTErrorThe member (FFN) does not exist in the loyalty program. It is excluded from normal retries but re-attempted by a dedicated scheduler.
PLAN_NAME_IS_INVALIDTerminal ErrorThe plan or segment attribute value is invalid. The transaction is marked as non-repeatable, with no further retries.
PROCESSEDTerminal SuccessThe lifecycle operation, either activation or cancellation, completed successfully.
ERRORErrorA generic failure occurred during processing. The transaction is retried by the reprocess scheduler while it remains under the retry limit.
SEGMENT_NOT_FOUND_IN_ANY_GROUPTerminal — CancellationThe cobranded segment was not found in any of the member's groups, so there was nothing to remove.

Response example — 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": ""
    }
  ]
}

Most common errors

Invalid or missing correlationId

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

Internal server error

If this error occurs, it is recommended to retry the request. If it persists, contact LATAM Pass support with the 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"
  }
}

ErrorException structure

FieldTypeDescription
codeinteger (int32)LATAM eFFP API internal code
messagestringError message description
instructionsstringInstructions to resolve the error
issuedDateTimestringDate and time the error was generated
detailsmap<string, object>Key-value pair with additional error details

Technical documentation

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