The content of this page was extracted in full from Check points accumulation | Developers | LATAM Pass .

Check points accumulation

GET

After a successful request in the POST method, it is possible to check the progress of the order through the GET method as per the  Swagger Retrieve Accrual GET documentation .

At least 2 fields are mandatory in the request, which is the  partnerIdentifier  (it is the partner.id field sent in the POST) and the other fields are at your discretion to perform the search, either by our ID or by the partner transaction that was sent in the POST method request (please check the fields available in the  Swagger Retrieve Accrual GET link ).

Here is an example CURL request:

curl --location --globoff 
'https://api.latampass.com/sandbox/v1/customer/loyalty/partner/accrual?partner
Identifier=1234\&id=1234\&ffn=1234\&partnerAccrualId=1234\&partnerTransaction
Id=1234\&createdStart=2023-09-01\&createdEnd=2023-09-30\&size=10' \\
--header 'client\_id: {{client\_id}}' \\
--header 'access\_token: {{access\_token}}' \\
--data ''

Below is an example of a successful response:

{
    "accruals": [
        {
            "id": 192,
            "correlationId": "bcd48e63-049a-417b-a23b-a98cd0a1b34b",
            "partnerAccrualId": "37fab402-a7cc-451a-8802-ff1c83e1f58d",
            "points": 3000,
            "productId": "001",
            "partnerTransactionId": "50db5dbf-7bbe-4baa-b4be-a3ffaa390a36",
            "partnerOriginDate": "2022-06-19T17:10:36.177-04:00",
            "description": "Blanditiis eius vitae sunt.",
            "ffn": "74613880610",
            "status": "PROCESSED",
            "latamAccrualId": "123456",
            "email": "Odessa99@hotmail.com",
            "createdAt": "2022-07-27T15:49:22.298376-04:00",
            "updatedAt": "2022-07-27T15:49:46.002400-04:00"
        }
    ],
    "totalPages": 1,
    "currentPage": 1,
    "totalItens": 1
}


Transaction asynchrony

Our processing is performed asynchronously because it contains several orchestrations, which is why our API has transient statuses that serve to inform the consumer about the progress of the transaction. Therefore, transient statuses are only important for monitoring and analysis. The possible statuses to be returned in the transaction query GET endpoint:

  • Transient statuses:
    • ACCRUAL_REQUESTED → Accumulation requested;  Transitory status of the flow .
    • ACCRUED → Accumulation completed;  Transient status of the flow .
    • ERROR → Transaction with error;  This status is a signal that there was a problem at some point in our flow, but it should not be considered as the final status, as it can be changed in our retry system ).
    • MEMBER_ENROLL_REQUESTED → Member creation requested;  Transitory flow status .
    • MEMBER_ENROLLED → Member creation completed;  Transitory flow status .
    • PROCESSING → Start of the flow when the transaction is received;
    • SEARCHING_MEMBER → Member search;  Transient status of the stream .
  • Final status:
    • CANCELLED → Cancelled Transaction;  THIS IS THE ONLY STATUS TO BE CONSIDERED AS A TRIGGER FOR TRANSACTION REVERSAL )
    • PROCESSED → End of the flow when the transaction is successfully processed;

Orders should only be cancelled and points returned to customers in the event of our  CANCELLED status return .

If a transaction's status does not change within 24 hours, you can contact us for analysis.

Therefore, while the transaction is in some transitory status, it is under our responsibility, with numerous possibilities such as: delay in processing, instability or error in some part of our flow or our integrations, inconsistency of customer data, among others, but there is still no resolution for the partner.

We ask that the refund be made only in CANCELLED status.