Get Cashback History

get

https://partner-api.getpliant.com/api/cashbacks/{organizationId}/history

Get the cashback redemption history for a specific organization. Use the limit and page parameters to paginate results, sortBy and sortDirection to sort, and the date filter parameters (createdAtFrom/createdAtTo, updatedAtFrom/updatedAtTo, paymentConfirmedAtFrom/paymentConfirmedAtTo) to narrow results by time range. Multiple date filters can be combined. Requests without pagination parameters return the first page with the default limit.

Path Params

organizationId

uuid

required

The organization for which the cashback history is requested.

Query Params

cardAccountId

uuid

The ID of the card account to get the cashback history for. If not provided, the default card account of the organization is used.

limit

integer

≤ 1000

Defaults to 50

The maximum number of items to return per page. Defaults to 50 if not provided, the maximum allowed value is 1000.

page

integer

Defaults to 0

The page number to return, starting with 0, this counts up to the total number of pages. The total number of pages is determined by the total number of records divided by the limit.

sortBy

string

enum

The field to sort by.

Allowed:

sortDirection

string

enum

The direction to sort by.

Allowed:

createdAtFrom

date-time

Filter records created at or after this timestamp. Uses ISO 8601 format.

createdAtTo

date-time

Filter records created at or before this timestamp. Uses ISO 8601 format.

updatedAtFrom

date-time

Filter records last updated at or after this timestamp. Uses ISO 8601 format.

updatedAtTo

date-time

Filter records last updated at or before this timestamp. Uses ISO 8601 format.

paymentConfirmedAtFrom

date-time

Filter records with payment confirmed at or after this timestamp. Uses ISO 8601 format.

paymentConfirmedAtTo

date-time

Filter records with payment confirmed at or before this timestamp. Uses ISO 8601 format.

Responses

204

No Content. The request was successful, but the system has no content to return. Most likely due to a deactivate feature module for the requested entity.

200Ok

400Bad Request. The API consumer sent a malformed request which could not be processed.

401Unauthorized. The API consumer is not authorized to access the requested resource.

403Forbidden. The API consumer is not allowed to access the requested resource.

404Not Found. The requested resource could not be found.

429Too Many Requests. The API consumer has sent too many requests in a given amount of time. Please check our API guidelines.

500Internal Server Error. The request was not completed due to an internal error.