POST
Query account balance overview
RestrictedUse this endpoint to retrieve per-currency account balance summaries and, when exchange rates are available, a display-currency total for overview purposes.
Restricted access
Access to the Account service APIs is enabled by Onerway approval.
Request
apikeyAccount service API key request header assigned by Onerway. Use the value for the same environment as the request base URL.
Example:
replace_with_account_service_apikeyx-timestampRequest timestamp. The gateway uses it to identify replay attempts.
Example:
1776931200Constraints
- Rule
- The timestamp must be within 10 minutes of the server time. Both 10-digit seconds and 13-digit milliseconds are accepted.
requestIdRequest ID used for idempotency control and request tracing.
Example:
REQ-BAL-OV-20260423-0001onBehalfOfSub-merchant number when a platform merchant queries on behalf of its sub-merchant. The caller merchant from
apikey must be the parent merchant.Example:
replace_with_sub_merchant_nodisplayCurrencyDisplay currency used to convert multi-currency balances into one display amount. Defaults to
USD when omitted. Use a three-letter ISO 4217 currency code.Example:
USDcurl -X POST 'https://sandbox-api.onerway.com/account-server/api/v2/account/balance/overview/query' \
-H 'Content-Type: application/json' \
--data-raw '{
"requestId": "REQ-BAL-OV-20260423-0001",
"displayCurrency": "USD"
}'Response
respCodeStandardized response code.
20000 indicates a successful response.respMsgHuman-readable response message aligned with
respCode.data{ totalAmount, displayCurrency, ... }Account balance overview payload.
error{ code, declineCode, ... }Standardized error object. It is null for successful responses and omitted from the JSON body.
{
"respCode": "20000",
"respMsg": "Success",
"data": {
"totalAmount": "5000.00",
"displayCurrency": "USD",
"currencyBalances": [
{
"currency": "USD",
"paymentBalance": "1500.00",
"fundingBalance": "1000.00",
"pendingSettlementBalance": "200.00",
"onHoldBalance": "100.00",
"riskDepositAmount": "200.00",
"totalBalance": "3000.00",
"status": "Active"
},
{
"currency": "EUR",
"paymentBalance": "1500.00",
"fundingBalance": "1000.00",
"pendingSettlementBalance": "0.00",
"onHoldBalance": "500.00",
"riskDepositAmount": "0.00",
"totalBalance": "2000.00",
"status": "Active"
}
]
}
}No error responses are documented for this endpoint.