GET
/
merchant-balance
curl --request GET \
  --url https://api-sandbox.koywe.com/rest/merchant-balance \
  --header 'Authorization: Bearer <token>'
{
  "reportByCountryAndCurrency": [
    {
      "country": "CHL",
      "currencies": [
        {
          "currency": "Chilean Peso",
          "totalOnOps": 123,
          "netOnCurrencyAmount": 123,
          "totalOffOps": 1,
          "netOffCurrencyAmount": 5000,
          "balance": 3255,
          "totalTopUpOps": 1,
          "netTopUpCurrencyAmount": 8255
        }
      ]
    }
  ],
  "dateOfBalance": "2024-05-16T19:50:00.932Z",
  "warning": "NEGATIVE TOPUP AMOUNT -$5"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

startDate
string
required

Start date of the query period in YYYY-MM-DD format

endDate
string
required

End date of the query period in YYYY-MM-DD format

Response

200 - application/json
reportByCountryAndCurrency
object[]
required
dateOfBalance
string
required
warning
string

A warning message related to the report, included when applicable.