Payouts
Balance Enquiry
Check your current payout account balance.
Balance Enquiry
API Version: 3.0.0
Generate an API key for Payouts by navigating to Payouts → API Keys → Add new API key.
Use this endpoint to check your current payout account balance. Always verify your balance before initiating a payout transfer.
Endpoint
| Method | URL |
|---|---|
| GET | https://payout.payorc.com/v1/balance |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
currency | String | No | Currency code to sync balance for (default: INR) |
Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization | String | Yes | Bearer token generated from the Create Token API |
Code Examples
curl --location 'https://payout.payorc.com/v1/balance?currency=INR' \
--header 'Authorization: Bearer {{payout-bearer-token}}'Response — Success (200)
{
"data": {
"balance": "100000.00",
"currency": "INR",
"last_updated": "2026-02-17 16:46:32"
},
"message": "Balance retrieved successfully",
"status": "success",
"code": "00"
}Response Fields
| Field | Type | Description |
|---|---|---|
data | Object | Contains balance details |
data.balance | String | Current account balance |
data.currency | String | Currency code |
data.last_updated | String | Last balance sync timestamp |
message | String | Balance retrieved successfully |
status | String | success |
code | String | 00 |
Response — Error (4xx)
{
"message": "Invalid or expired token",
"status": "fail",
"code": "E0401"
}Error Response Fields
| Field | Type | Description |
|---|---|---|
message | String | Response description |
status | String | API call status (success / fail) |
code | String | Response code |
If you receive an invalid token error, ensure you have generated a valid authentication token using the Create Token API.