Get Redemption Status

After submitting a Create Redemption request, partners can query the current status of the transaction using the correlationId returned in the 201 response.

Processing is asynchronous. It is recommended to use webhook notifications as the primary mechanism for receiving the final status. Use the GET endpoint only as an alternative if a webhook notification is not received after 24 hours, or to verify the current state of a transaction.

Request

Method: GET

Endpoint:

https://api.latampass.com/sandbox/v1/customer/eloyalty/partner/redeem?correlationId={uuid}

Authentication: Flow B — Portal API Client Credentials

Query parameter:

Parameter	Type	Required	Description
`correlationId`	UUID	Yes	UUID returned from a previous Create Redemption response

Example request:

curl 'https://api.latampass.com/sandbox/v1/customer/eloyalty/partner/redeem?correlationId=<YOUR_CORRELATION_ID>' \
  --request GET \
  --header 'x-latam-test: LatamPass' \
  --header 'Access_token: <YOUR_UUID_ACCESS_TOKEN>' \
  --header 'client_id: <YOUR_CLIENT_ID>' \
  --header 'Content-Type: application/json'

Headers

Header	Value	Description
`Access_token`	`<UUID_ACCESS_TOKEN>`	Portal API client credentials token (Flow B)
`client_id`	`<YOUR_CLIENT_ID>`	Portal API client identifier
`x-latam-test`	`LatamPass`	Required in sandbox only. Omit in production
`Content-Type`	`application/json`

Response

A successful request returns HTTP 200 OK.

Transaction statuses:

Status	Type	Description
`PROCESSING`	Intermediate	Request is being processed
`PROCESSED`	Final	Miles successfully debited. Eligible for cancellation
`ERROR`	Final	Processing failed. See the `exception` field for details
`CANCELLED`	Final	Request cancelled. Miles were not debited

Response fields:

Field	Type	Present when
`correlationId`	UUID	Always
`status`	String	Always
`description`	String	Always
`ffn`	String (masked)	Always
`miles`	Integer	Always
`partnerTransactionId`	String	Always
`redemptionId`	String	When status is `PROCESSED` (omitted while `PROCESSING`)
`exception`	Object	When status is `ERROR`

exception object fields:

Field	Type	Description
`message`	String	Human-readable error description
`code`	String	Error code identifier (e.g. `InsufficientAccountBalance`)
`instructions`	String	Recommended action for the partner

Example responses:

Status: PROCESSING

{
  "correlationId": "<YOUR_CORRELATION_ID>",
  "status": "PROCESSING",
  "description": "Demo API redeem",
  "ffn": "****6789",
  "miles": 15,
  "partnerTransactionId": "<YOUR_PARTER_TRANSACTION_ID>"
}

Status: PROCESSED

{
  "correlationId": "<YOUR_CORRELATION_ID>",
  "status": "PROCESSED",
  "description": "Demo API redeem",
  "ffn": "****6789",
  "miles": 15,
  "partnerTransactionId": "TXN-TEST-1769171650",
  "redemptionId": "<YOUR_REDEMPTION_ID>"
}

Status: ERROR

{
  "correlationId": "<YOUR_CORRELATION_ID>",
  "status": "ERROR",
  "description": "Demo API redeem",
  "ffn": "****6789",
  "miles": 15,
  "partnerTransactionId": "<YOUR_PARTNER_TRANSACTION_ID>",
  "exception": {
    "message": "The account balance is insufficient",
    "code": "InsufficientAccountBalance",
    "instructions": "Check the available balance or add funds to continue."
  }
}

Common errors

400 — Missing correlationId

{
  "message": "Request payload has problems with validation",
  "code": 400,
  "instructions": null,
  "details": {
    "correlationId": "Missing required parameter"
  },
  "issueDateTime": "2026-01-23T12:54:25.044344Z"
}

400 — Invalid correlationId format

{
  "message": "Request payload has problems with validation",
  "code": 400,
  "instructions": null,
  "details": {
    "getRedeemByCorrelationId.correlationId": "correlationId must be a valid UUID"
  },
  "issueDateTime": "2026-01-23T12:54:25.044344Z"
}

404 — Redemption not found

{
  "message": "Redeem not found for correlation ID: <YOUR_CORRELATION_ID>",
  "code": 404,
  "instructions": null,
  "details": null,
  "issueDateTime": "2026-01-23T12:54:25.044344Z"
}