Order list

Get a list of your orders:

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

{
  "from": "2024-08-29 12:00:00",
  "to": "2024-08-30 23:35:59",
  "status": "paid",
  "payment_method": "pix",
  "sort": "paid_at",
  "direction": "desc",
  "page": 1,
  "per_page": 40
}

Param descriptions

Param	Mandatory	Values	Default
from	false	YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	Today at 00:00:00 -03:00
to	false	YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Timezone is -03:00)	Today at 23:59:59 -03:00
status	false	waiting_payment, canceled, reversed, paid, chargeback, expired, analysis, initial	All
payment_method	false	pix	All
sort	false	paid_at, compensated_at, reversed_at, created_at, chargeback_at (defaults according to status.)	created_at
direction	false	desc or asc	desc
page	false	Any integer >= 1	1
per_page	false	Any integer >= 1	Maximum is 200

The response will be a list of orders with the following format:

{
  "orders": [
    {
      "latam_id": "1ax234b5-67cd-8aab-118a-0d629796d28d",
      "code": "01234567899910215680042611",
      "secondary_code": "123",
      "customer_name": "Customer Name",
      "original_amount": "100.0",
      "status": "paid",
      "final": true,
      "created_at": "2025-01-02T16:30:27-03:00",
      "paid_at": "2025-01-02T17:26:13-03:00",
      "payment_method": "pix",
    },
    {
      "latam_id": "4by113t8-67cd-8aab-118a-0d629796d28d",
      "code": "01234567899910215680042611",
      "secondary_code": "abc",
      "customer_name": "Customer Name",
      "original_amount": "100.0",
      "status": "paid",
      "final": true,
      "created_at": "2025-01-02T16:30:27-03:00",
      "paid_at": "2025-01-02T17:26:13-03:00",
      "payment_method": "pix",
    }
  ],
  "total_pages": 1,
  "current_page": 1,
  "per_page": 30
}

Response params descriptions

Param	Description	Value Type
latam_id	Order ID into the Latam’s system	String
code	The ID from your system	String
customer_name	Customer name	String
customer_email	Customer email	String
original_amount	Order value sent by you	Number (decimal)
fee	Your fee	Number (decimal)
tax	Your tax	Number (decimal)
additional_value	Additional fee charged to the customer	Number (decimal)
final_value	Final value of the order after fees	Number (decimal)
status	Order current status *	String
final	Boolean to indicate if the order status is final	Boolean
created_at	Order’s creation Timestamp	Timestamp
paid_at	Order’s paid Timestamp	Timestamp
chargeback_at	Order’s chargeback Timestamp (Credit Card only)	Timestamp
reason	Reason in case of failing order	String
payment_method	Order’s payment method	String
provider	Order’s payment provider	String
money_laundry_prevention	Indicates if money laundering prevention measures were applied	Boolean
ocbs	Binance’s internal control	Boolean

• When checking the status of orders, please note that paid orders may still be modified unless the “Final” field is set to true.