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
| Property | Value |
|---|
| Method | GET |
| Path | /v1/customer/loyalty/partner/cobranded |
| Name | Value | Description | Type | Required |
|---|
x-issue-bank | <bank code> | Identification of the card-issuing bank | String | Yes |
client_id | <your_client_id> | Value obtained from the Dev Tools > My Apps > Client ID menu | String | Yes |
access_token | <access_token> | Access token obtained during authentication | String | Yes |
x-latam-test | LatamPass | For use in the sandbox environment only. Must not be sent in production | String | No |
Query Parameters
| Name | Value | Description | Type | Required |
|---|
correlationId | <correlation_id> | Correlation ID received in the response of create, delete, upgrade, or downgrade operations | String | Yes |
Request example
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
| Field | Type | Description |
|---|
trace | object (TraceConsult) | Traceability information and operation dates |
member | object (Member) | LATAM Pass member information |
cards | list of (Card) | Cards affected by the operation. 1 entry (create/delete) or 2 (upgrade/downgrade) |
TraceConsult
| Field | Type | Description |
|---|
correlationId | string | Correlation identifier between LATAM eFFP API resources |
approvedAt | string | Date and time the operation was approved |
createdAt | string | Date and time the record was created |
Member
| Field | Type | Description |
|---|
ffn | string | Member number |
Card
| Field | Type | Description |
|---|
brand | string (enum) | Card brand: AMEX, MASTERCARD, VISA |
category | string | Card category |
tier | integer | Card category level |
cardStatus | string (enum) | Operation performed on the card: ACTIVE (create), CANCELLED (delete), UPGRADE (upgrade), DOWNGRADE (downgrade) |
status | string (enum) | See Transaccion Status Table |
error | string | Error detail. Only present when status is ERROR |
Transaction Status
| Status | Type | Description |
|---|
RECEIVED | Initial | A card activation request was received and persisted, pending processing. |
CANCELLING | Initial | A card cancellation request was received and is being processed. |
RETRIEVED_SEGMENTS | Intermediate | The member's segments were successfully fetched from the loyalty program. |
INSERTED_GROUP_SEGMENTS | Intermediate — Activation | The cobranded group segments were inserted into the member's profile. |
REMOVED_GROUP_SEGMENTS | Intermediate — Cancellation | The cobranded group segments were removed from the member's profile. |
SECONDARY_FFN_RETRIEVED | Intermediate | The member's secondary frequent flyer number (FFN) was resolved, and the record was re-queued under it. |
MEMBER_NOT_EXIST | Error | The 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_INVALID | Terminal Error | The plan or segment attribute value is invalid. The transaction is marked as non-repeatable, with no further retries. |
PROCESSED | Terminal Success | The lifecycle operation, either activation or cancellation, completed successfully. |
ERROR | Error | A 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_GROUP | Terminal — Cancellation | The cobranded segment was not found in any of the member's groups, so there was nothing to remove. |
Response example — 200
Most common errors
Invalid or missing correlationId
Internal server error
If this error occurs, it is recommended to retry the request. If it persists, contact LATAM Pass support with the correlationId.
ErrorException structure
| Field | Type | Description |
|---|
code | integer (int32) | LATAM eFFP API internal code |
message | string | Error message description |
instructions | string | Instructions to resolve the error |
issuedDateTime | string | Date and time the error was generated |
details | map<string, object> | Key-value pair with additional error details |
Technical documentation
Click here to access the complete technical specification (Swagger).