A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"name": "<string>",
"type": "INDIVIDUAL",
"code_config": {
"pattern": "<string>",
"length": 123,
"charset": "<string>",
"prefix": "<string>",
"postfix": "<string>"
},
"points_expiration": {
"rolling_expiration": {
"period": {
"value": 123
},
"rounding": {
"value": 6
}
},
"calendar_expiration": {
"expiration_dates": [
{
"day": 16,
"month": 6
}
]
},
"sliding_expiration": {
"custom_activity_types": [
"<string>"
],
"period": {
"value": 123
},
"earning_activity": true,
"spending_activity": true,
"custom_activity": true
}
},
"pending_points": {
"period_based": {
"period": {
"value": 123
}
},
"fixed_dates": {
"dates": [
{
"day": 16,
"month": 6
}
]
},
"event_based": {
"event_types": [
"<string>"
],
"cancel_period": {
"value": 123
}
}
},
"earning_limits": {
"global": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
},
"transactions": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
}
},
"spending_limits": {
"global": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
},
"transactions": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
}
},
"refunds": {
"spent_points": {
"methods": [
{
"type": "<string>"
}
]
},
"earned_points": {
"methods": [
{
"type": "<string>"
}
]
}
},
"balance_settings": {
"allow_negative": true
},
"pay_with_points": {
"exchange_ratio": {
"formula": "<string>"
}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}List Card Definitions
This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.
Returns a cursor-paginated list of card definitions.
Filtering is supported through the filters deep-object query parameter,
e.g. filters[name][conditions][$is]=Standard%20Card.
The same field cannot be requested in both ascending and descending
order at the same time.
A valid request URL is required to generate request examples{
"data": [
{
"id": "<string>",
"name": "<string>",
"type": "INDIVIDUAL",
"code_config": {
"pattern": "<string>",
"length": 123,
"charset": "<string>",
"prefix": "<string>",
"postfix": "<string>"
},
"points_expiration": {
"rolling_expiration": {
"period": {
"value": 123
},
"rounding": {
"value": 6
}
},
"calendar_expiration": {
"expiration_dates": [
{
"day": 16,
"month": 6
}
]
},
"sliding_expiration": {
"custom_activity_types": [
"<string>"
],
"period": {
"value": 123
},
"earning_activity": true,
"spending_activity": true,
"custom_activity": true
}
},
"pending_points": {
"period_based": {
"period": {
"value": 123
}
},
"fixed_dates": {
"dates": [
{
"day": 16,
"month": 6
}
]
},
"event_based": {
"event_types": [
"<string>"
],
"cancel_period": {
"value": 123
}
}
},
"earning_limits": {
"global": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
},
"transactions": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
}
},
"spending_limits": {
"global": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
},
"transactions": {
"limits": [
{
"type": "<string>",
"max": 123
}
]
}
},
"refunds": {
"spent_points": {
"methods": [
{
"type": "<string>"
}
]
},
"earned_points": {
"methods": [
{
"type": "<string>"
}
]
}
},
"balance_settings": {
"allow_negative": true
},
"pay_with_points": {
"exchange_ratio": {
"formula": "<string>"
}
},
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"object": "<string>"
}
],
"cursor": {
"next": "<string>",
"expires_at": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Maximum number of card definitions to return. Minimum: 1, maximum: 100. Defaults to 10 when omitted.
1 <= x <= 100Sort order. A single field or an array of fields. Prefix a field with - for
descending order. Defaults to -created_at. The same field cannot be used in
both ascending and descending direction at the same time.
-name, name, -type, type, -status, status, -created_at, created_at Pagination cursor returned by a previous call in cursor.next. Pattern: ^lcrscdef_[a-f0-9]+$.
^lcrscdef_[a-f0-9]+$Filter conditions per field, e.g. filters[status][conditions][$is]=ACTIVE.
Filters for the card definitions list endpoint. Each field accepts a
conditions object; provided conditions must be valid for the field type.
Show child attributes
Show child attributes
Response
A paginated list of card definitions.
Cursor-paginated list of card definitions.
Was this page helpful?