Plexy
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Orders
  • Overview
  • Products
    • List product types
      GET
    • List product categories
      GET
    • List products
      GET
    • Get product
      GET
  • Orders
    • List orders
      GET
    • Create order
      POST
    • Get order by ID
      GET
  • Balances
    • Get balance
      GET
  • Deposits
    • List deposit history
      GET
  • System
    • API health
      GET
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Orders

List orders

GET
/agent/{agent_id}/orders
Returns a paginated list of orders for this agent with filters.

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Query Params

Responses

🟢200
application/json
OK
Body

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/agent/a12d5be1-3456-4c18-b111-33cdd0a1cc99/orders?page&pageSize&status&product_id' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Orders page
{
    "items": [
        {
            "id": "5c1f4f9d-8b5a-4e8b-8c0e-1d1c2f3a4b5c",
            "product_id": 456,
            "external_ref": "INV-1001",
            "idempotency_key": "order-1001",
            "status": "completed",
            "order_content": {
                "voucher_code": "ABCD-EFGH-IJKL"
            },
            "currency_code": "USD",
            "charged_amount": "12.50",
            "balance_after": "87.50",
            "balance_before": "100.00",
            "is_test": false,
            "region_code": "GLOBAL",
            "created_at": "2024-11-01T10:00:00Z",
            "completed_at": "2024-11-01T10:01:30Z",
            "failed_at": null
        }
    ],
    "page": 1,
    "pageSize": 50,
    "total": 1
}
Modified at 2025-12-12 12:02:13
Previous
Get product
Next
Create order
Built with