UPP Docs
Balance

List balances

GET
/balances

The merchant's real-time balance per currency, in ascending currency code order, without pagination. Balances are read from the merchant's cash account on every request; currencies that were never posted are not listed, and an empty array is returned when there has never been a balance. available can be used for withdrawals, card issuing, card top-ups and exchanges; pending is a deposit that has arrived and awaits manual review and cannot be used; held is held while an operation awaits its result (withdrawals, card issuing, card top-ups and exchanges) and returns to the available balance on failure. total is the sum of the three. For the entries behind balance changes, see GET /transactions.

Authorization

merchantApiKeymerchantTimestampmerchantNoncemerchantSignature
headerX-API-KEY<token>

Merchant API key (starts with upk_, also accepts api-key); signing headers are also required

headerX-Timestamp<token>

Unix timestamp in seconds, within 300 seconds of server time

headerX-Nonce<token>

Unique per request; cannot be reused with the same credential during the timestamp validity window

headerX-Signature<token>

Hex HMAC-SHA256 signature (either letter case) of the method, full path, timestamp, nonce and body digest

Response Body

Balances per currency

application/json
  1. response
data*array<>
Example Request
curl -X GET 'https://sandbox.getupp.net/api/v1/balances'
Example Response
{  "data": [    {      "currency": "EUR",      "total": "5.50",      "available": "5.50",      "pending": "0.00",      "held": "0.00"    },    {      "currency": "USD",      "total": "100.00",      "available": "90.00",      "pending": "0.00",      "held": "10.00"    }  ]}