Should you notice any errors in our documentation, please don’t hesitate to contact us. Thank you!
List
GET
https://www-staging.givve.com/api/vouchers
Last modified:2025-06-11 10:01:41
Voucher List
Filterable Attributes
| Attribute Name | Meaning |
|---|---|
| customer_id | Id of the customer whose vouchers are to be listed |
| replacement_id | Lists vouchers whose replacement is the given id |
| expires_on | Expiration date of the vouchers |
| token | Token of the vouchers |
| excluded_from_load_order | Lists vouchers that are excluded from load orders |
| renew | Lists vouchers that will be renewed on expiration |
| category | Category of the vouchers to be listed |
| balance.cents | Balance of the vouchers in the currents smallest unit (e.g. cents for Euros, pence for UK Pound) |
Return
{
"meta": {
"total_pages": 0,
"current_page": 0,
"page_size": 0,
"total_entries": 0
},
"data": [
{
"id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"awaiting_activation": true,
"last_activation_at": "2019-08-24T14:15:22Z",
"balance": {
"cents": 0,
"currency": "EUR"
},
"blocked_amount": {
"cents": 0,
"currency": "EUR"
},
"currency": "string",
"customer": {
"type": "customer",
"name": "Company 45",
"id": "66cdd0fbe817b3d4c42e41bf"
},
"emboss_line_1": "string",
"emboss_line_2": "string",
"excluded_from_load_order": true,
"expires_on": "2019-08-24T14:15:22Z",
"renew": true,
"state": "string",
"payment_locks": [
"-"
],
"image_id": "string",
"replacement": {
"prev": null,
"next": null
},
"token": "string",
"mcc_group": "BON-MC-591",
"owner": {
"id": "string",
"identifier": null,
"name": "string",
"title": null,
"first_name": "string",
"last_name": "string",
"email": "string",
"pending_email": "string",
"pending_email_expires_at": "string",
"address_line_1": "string",
"address_line_2": "string",
"zip_code": "12345",
"city": "City",
"country_code": "276"
},
"configuration_changeable": true,
"configuration": {
"id": "string",
"type": "classic",
"merchant": {
"id": "string",
"name": "string"
},
"postal_data": {
"id": "string",
"postal_code": "string",
"town_name": {
"de": "string",
"en": "string"
},
"town_name_affix": {
"de": "string",
"en": "string"
},
"display_name": {
"de": "string",
"en": "string"
},
"postal_code_area": "string",
"associated_postal_code_areas": [
"string"
]
}
},
"allow_3d_secure_enrolment": true,
"allow_mobile_wallet_enrolment": false,
"category": "unlimited"
}
],
"links": {
"self": "http://example.com",
"first": "http://example.com",
"prev": "http://example.com",
"next": "http://example.com",
"last": "http://example.com"
}
}Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://www-staging.givve.com/api/vouchers?sort=created_at&skip_meta_totals=&page[number]=1&page[size]=25' \
--header 'Authorization: Bearer ' \
--header 'Accept-Version: v2' \
--header 'Content-Type: text/csv'Response Response Example
{}Request
Query Params
sort
string
optional
Example:
created_at
skip_meta_totals
boolean
optional
page[number]
integer
optional
Example:
1
page[size]
integer
optional
Example:
25
Header Params
Authorization
string
required
Example:
Bearer {{token}}
Accept-Version
string
required
Example:
v2
Content-Type
string
optional
Example:
text/csv
Responses
Modified at 2025-06-11 10:01:41