Get all credit records
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
Query parameters
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.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
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.
Direction of sorting the response list.
The unique ID of the customer. GET /customers
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
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.
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
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"credits": [
{
"credit_id": "8bed991c68a470e7aaeffbf048",
"customer_id": "8ea2591121e636086a4a9c0992",
"assigned_credits": 1000,
"available_credits": 1000,
"credit_type_id": "86e05affc7a7abefcd513ab400",
"partner_id": "86e05affc7a7abefcd513ab400",
"valid_to": "2027-12-12 00:00:00",
"currency_id": "86e05affc7a7abefcd513ab400",
"state": 1
}
],
"total_items": 1
}
}