Should you notice any errors in our documentation, please don’t hesitate to contact us. Thank you!

List Vouchers

GET

/vouchers

Last modified:2026-03-31 13:51:02

x-allowed-tags:["any_view","any_manage"]

x-allow-access:["Multiplier","Customer","VoucherOwner"]

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

get Voucher(s)

Body

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET '/vouchers?sort&skip_meta_totals&page[number]&page[size]&$in=&$in=&$in=&$in=&$in=&$in=&$in=&$in=&$nin=&$nin=&$nin=&$nin=&$nin=&$nin=&$nin=&$nin=&$gte=&$gte=&$gte=&$gte=&$gte=&$gte=&$gte=&$gte=&$lte=&$lte=&$lte=&$lte=&$lte=&$lte=&$lte=&$lte=&$gt=&$gt=&$gt=&$gt=&$gt=&$gt=&$gt=&$gt=&$lt=&$lt=&$lt=&$lt=&$lt=&$lt=&$lt=&$lt=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "meta": {
        "total_pages": 0,
        "current_page": 0,
        "page_size": 0,
        "total_entries": 0
    },
    "data": [
        {
            "id": "string",
            "activatable": true,
            "awaiting_activation": true,
            "last_activation_at": null,
            "balance": null,
            "blocked_amount": null,
            "created_at": "2019-08-24T14:15:22.123Z",
            "currency": "string",
            "customer": null,
            "emboss_line_1": null,
            "emboss_line_2": null,
            "excluded_from_load_order": true,
            "expires_on": "2019-08-24",
            "renew": true,
            "mcc_group": "string",
            "replacement": {
                "prev": null,
                "next": null
            },
            "state": "string",
            "payment_locks": [
                "string"
            ],
            "image_id": null,
            "token": "string",
            "owner": {
                "id": "string",
                "identifier": null,
                "title": null,
                "name": null,
                "first_name": "string",
                "last_name": "string",
                "email": null,
                "pending_email": null,
                "pending_email_expires_at": null,
                "address_line_1": null,
                "address_line_2": null,
                "zip_code": null,
                "city": null,
                "country_code": null,
                "property1": "string",
                "property2": "string"
            },
            "updated_at": "2019-08-24T14:15:22.123Z",
            "configuration_changeable": true,
            "configuration": null,
            "number": null,
            "allow_3d_secure_enrolment": true,
            "allow_mobile_wallet_enrolment": true,
            "is_3d_secure_enrolled": true,
            "is_mobile_wallet_enroled": true,
            "pin_last_updated_at": null,
            "category": "benefit_in_kind"
        }
    ],
    "links": {
        "self": "http://example.com",
        "first": "http://example.com",
        "prev": null,
        "next": null,
        "last": "http://example.com"
    }
}

Modified at 2026-03-31 13:51:02

List Vouchers

Get Voucher