GET
/
v1
/
voucher
/
get-many
curl --request GET \
  --url https://staging-vouchers.ventogram.com/api/v1/voucher/get-many \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "amount": 123,
      "fee": 123,
      "currency": "<string>",
      "feeBearer": "client",
      "expectedAmount": 123,
      "fullname": "<string>",
      "paymentStatus": "paid",
      "merchant": "<string>",
      "memo": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "rateKey": "<string>",
      "voucherCode": "<string>",
      "paidAt": "2023-11-07T05:31:56Z",
      "receivedAmount": 123,
      "dateRedeemed": "2023-11-07T05:31:56Z",
      "rate": 123
    }
  ],
  "meta": {
    "nextPage": "<string>",
    "prevPage": "<string>"
  }
}

Authorizations

​
X-Api-User
string
header
required
​
X-Api-Key
string
header
required

Query Parameters

​
page
number

Defaults to 1. This is the current page being requested relative to size of a page

​
pageSize
number

The number of items to be retured per page

​
paymentStatus
enum<string>

Voucher payment status

Available options:
paid,
unpaid

Response

200
application/json
successful operation
​
success
boolean
​
message
string
​
data
object[]

An array containing the retrieved voucher records, sorted in descending order by their creation date.

​
meta
object
Retrieve voucher recordRedeem existing unused voucher