Skip to main content
GET
List customer credits

Authorizations

Authorization
string
header
required

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

Path Parameters

businessId
string<uuid>
required

The UUID of the business to fetch customer credits for.

Query Parameters

customer_id
string<uuid>

Filter customer credits by customer ID.

sent_at_start
string<date-time>

Filter customer credits by sent date. Customer credits received on or after this date will be included. ISO 8601 date format.

sent_at_end
string<date-time>

Filter customer credits by sent date. Customer credits received before this date will be included. ISO 8601 date format.

memo
string

Filter customer credits by exact memo match.

memo_contains
string

Filter customer credits where memo contains this substring.

reference_number
string

Filter by exact reference number match. Returns only records with this exact reference number.

reference_numbers
string

Comma-separated list of reference numbers to filter customer credits by. Only customer credits with reference numbers matching any value in this list will be returned.

Response

200 - application/json

Success.

data
object[]
required
meta
object

Request metadata. Present on paginated list responses.