GET
/
v1
/
vouchers
Retrieve voucher record
curl --request GET \
  --url https://staging-vouchers.ventogram.com/api/v1/vouchers \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": [
    {
      "id": "<string>",
      "email": "<string>",
      "amount": 123,
      "fullname": "<string>",
      "currency": "<string>",
      "fee": 123,
      "feeBearer": "<string>",
      "paymentStatus": "paid",
      "paymentExpiresAt": "2023-11-07T05:31:56Z",
      "merchant": "<string>",
      "memo": "<string>",
      "voucherCode": "<string>",
      "createdAt": "<string>",
      "dateRedeemed": "2023-11-07T05:31:56Z",
      "accountType": "<string>",
      "cancelledAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

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

Query Parameters

id
string

Voucher id

memo
string

Voucher memo or reference number

accountNumber
string

The account number used to pay for voucher

Response

successful operation

The response is of type object.