API Reference

Get all credit records

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/credits

Get a list of all credit transactions and their current values.

Credits are the monetary loyalty currency stored in a customer's wallet alongside reward points. Each credit record captures the amount, credit type, currency, customer, partner, creation timestamp, and an optional note.

Use the customer_id filter to retrieve credits for a specific customer, credit_type_id to narrow results to a specific loyalty program or promotional category, and the create_credit_time_from/create_credit_time_to parameters to filter by creation date.

Related: GET /credit-types, GET /credit-history

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 100

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.

integer
≥ 0
Defaults to 0

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

string

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.

string
enum

Direction of sorting the response list.

Allowed:
string

The unique ID of the customer. GET /customers

string

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

string

Start of the time interval for filtering credit records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

string

End of the time interval for filtering credit records by creation time. Accepts the format YYYY-MM-DD HH:MM:SS or ISO-8601 format (YYYY-MM-DDTHH:MM:SS). All times are in the local timezone.

Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 3 months ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago