List all Orders

Retrieve a list of orders.

Endpoint

GET /v1/orders

Scope

orders:all

Request

Query Parameters

All these parameters are optional.

Name	Type	Description
page	integer	The number of the page to return.
pageSize	integer	The number of the size of the page.
type	TOKENIZE | REDEEM	The type of orders.
status	PENDING | SUCCEEDED | SETTLED | BROADCAST | FAILED	The status of the orders to retrieve

GET /v1/orders?page=1&pageSize=30&type=TOKENIZE&status=SUCCEEDED

Response

Name	Type	Description
output	Array<Order>	The list of orders.
code	string	The response status code text.

Response Body

{
  "output": [
    {
      "id": "84203386-d88a-92cb-b5fe-61c328euffhueif49",
      "status": "PENDING",
      "amount": "2000",
      "type": "TOKENIZE",
      "created_at": "2023-11-04T01:35:34.165Z",
      "updated_at": "2023-11-04T01:35:34.165Z",
      "origin_source_id": "F7D07279-253D-4003-9A0D-B512F6C14A21",
      "destination_source_id": "AEA37EBA-F1DF-4FE5-805B-A09A25BB4921",
      "activities": [
        {
          "type": "SETTLE_ORDER",
          "status": "PENDING",
          "last_update_at": "2023-11-04T01:35:34.162Z"
        }
      ],
      "status_code": null,
      "chain": "POLYGON",
      "public_data": {
        "financial_items": {
          "transfer_amount": "2000.00"
        },
        "deposit_originated_at": "2023-11-13T00:00:00.000Z"
      },
      "external_identifier": null,
      "effective_amount": "2000",
    }
  ],
  "code": "OK"
}

Test the endpoint

Production

curl -X GET 'https://api.minteo.finance/v1/orders' \
-H 'Authorization: Bearer <your-api-key>'

Sandbox

curl -X GET 'https://api.sandbox.minteo.finance/v1/orders' \
-H 'Authorization: Bearer <your-api-key>'