Skip to main content

Get Benefits List

This endpoint allows to get benefits available to a customer.

Request

GET <API base url>/customers/{id}/benefits

URL query parameters

NameTypeRequiredDescription
iduint64yesCustomer identifier
languagestringyesTwo letter language code according to ISO 639-1
cardTypesstring[]noFilter by card type

Response

On success:

{
"value": required array of {
"id": required number,
"name": required string,
"description": optional string,
"icon": optional string (as URL),
"termsOfUse": optional string,
"cardTypes": optional array of string
}
}