v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Credit types

Get all credit types

Get a list of all credit types.

Credit types are program-based categories that credits belong to. They distinguish between different loyalty programs or purposes - for example, standard loyalty credits, promotional credits, or partner-specific credit programs. Every credit record is assigned to exactly one credit type.

Use this endpoint to retrieve the available credit type IDs when depositing or reducing credits. If no credit type is specified on a deposit or reduction, the project-default credit type is applied automatically.

Related: POST /credits/actions/deposit (enterprise interface only), GET /credits

get/credit-types

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "credit_types": [
      {
        "credit_type_id": "86e05affc7a7abefcd513ab400",
        "name": "Addition",
        "last_change": "2022-04-05 07:46:44.190403"
      }
    ],
    "total_items": 1
  }
}