v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Wallet

Get credits overview

Get information about credits overview of the customer in the time interval.

get/wallet/actions/credits-overview

Query parameters

customer_idstring required

The unique ID of the customer. GET /customers

date_fromstring

Start of the time interval in ISO-8601 format (YYYY-MM-DD).

date_tostring

End of the time interval in ISO-8601 format (YYYY-MM-DD).

credit_type_idstring

The unique ID of a credit type. The filter reduces data in the response related only to the selected credit type. GET /credit-types

In case you want to filter multiple options use array syntax : credit_type_id[]=8bc8ca16f9c5039951021700a2&credit_type_id[]=82c06812c0756528660784fef

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "earned_credits": 100,
    "redeemed_credits": 20.5,
    "available_credits": 79.5,
    "split_by_currency": [
      {
        "currency_id": "86e05affc7a7abefcd513ab400",
        "earned_credits": 100,
        "redeemed_credits": 20.5,
        "available_credits": 79.5
      }
    ]
  }
}