Plexy
Pay APIGate APIDashboard
Pay APIGate APIDashboard
  1. Balances
  • 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. Balances

Get balance

GET
/agent/{agent_id}/balance
Returns current balance per currency for this agent.

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path 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/balance' \
--header 'Authorization: <api-key>'
Response Response Example
200 - Balances per currency
{
    "items": [
        {
            "currency_code": "USD",
            "available": "87.50",
            "updated_at": "2024-11-01T10:01:30Z"
        },
        {
            "currency_code": "EUR",
            "available": "10.00",
            "updated_at": "2024-11-01T09:00:00Z"
        }
    ]
}
Modified at 2025-12-12 12:02:13
Previous
Get order by ID
Next
List deposit history
Built with