Skip to content

Order details

Check orders status and more details.

You can check the transaction status at any time:

GET /v1/orders/{latam_id}
Host: query.latamgateway.com
Content-Type: application/json
ACCOUNT_TOKEN: "<token>"

The response will be:

 {
            "latam_id": "f99764cf-4dd6-4a55-83ab-f06cf11574b6",
            "code": "12345678901",
            "customer_name": "Customer's Name",
            "customer_email": "[email protected]",
            "original_amount": "1.1",
            "fee": "0.1",
            "tax": "0.0",
            "additional_value": 0.0,
            "final_value": 1.0,
            "status": "paid",
            "final": true,
            "created_at": "2024-08-29T23:45:58-03:00",
            "paid_at": "2024-08-29T23:46:10-03:00",
            "chargeback_at": null,
            "reason": "",
            "payment_method": "pix",
            "money_laundry_prevention": false,
            "ocbs": false,
            "payment": {}
        }

Response params descriptions

Param Description
latam_id Order ID into the Latam’s system
code The ID from your system
customer_name Customer name
customer_email Customer email
original_amount Order value sent by you
fee Latam's fee in the order in BRL
tax Latam's tax in the order in BRL
additional_value Additional fee charged to the customer
final_value Final value of the order after fees
status Order current status *
final Boolean to indicate if the order status is final
created_at Order’s creation Timestamp
paid_at Order’s paid Timestamp
chargeback_at Order’s chargeback Timestamp (Credit Card only)
reason Reason in case of failing order
payment_method Order’s payment method
money_laundry_prevention Indicates if money laundering prevention measures were applied
ocbs This field is exclusive to Binance. Its value will always be False.
payment JSON containing payment details. Each payment method has its own structure
  • When checking the status of orders, please note that paid orders may still be modified unless the “Final” field is set to true.