Plexy
Pay APIGate API
Dashboard
Pay APIGate API
Dashboard
  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
  1. Orders

Create order

POST
/agent/{agent_id}/orders
Creates an order for this agent, computes plexy_margin and agent_charge, and reserves agent balance. For direct_top_up products, include a topup_request payload with customer account details and the requested amount.

Request

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Created
Body

🟠400
🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/agent/a12d5be1-3456-4c18-b111-33cdd0a1cc99/orders' \
--header 'Idempotency-Key: order-1001' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "product_id": 456,
    "currency_code": "USD",
    "topup_request": {
        "amount": "10.00",
        "customer_account": {
            "steam_login": "player123",
            "email": "user@example.com"
        }
    },
    "external_ref": "INV-1001"
}'
Response Response Example
201 - Order created
{
    "id": "5c1f4f9d-8b5a-4e8b-8c0e-1d1c2f3a4b5c",
    "product_id": 456,
    "external_ref": "INV-1001",
    "idempotency_key": "order-1001",
    "status": "pending",
    "order_content": {
        "vendor_order_id": "LC-123456"
    },
    "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": null,
    "failed_at": null
}
Modified at 2025-12-12 12:02:13
Previous
List orders
Next
Get order by ID
Built with