POST
/
v1
/
vouchers
curl --request POST \
  --url https://staging-vouchers.ventogram.com/api/v1/vouchers \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>' \
  --data '{
  "email": "<string>",
  "fullname": "<string>",
  "amount": 123,
  "currency": "NGN",
  "rateKey": "<string>"
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>"
  }
}

Authorizations

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

Body

application/json
email
string
required

User email

fullname
string
required

Fullname of the user creating voucher

amount
integer
required

Required voucher amount

currency
enum<string>
required

Required voucher currency

Available options:
NGN,
GHS
rateKey
string

This is a Ventogram-signed rate key. If provided when a voucher is created, the conversion will use the rate signed with this key if it is valid at the time of redeeming a voucher. Conversion will use the current rate if key has expired.

Response

201
application/json
successful operation
success
boolean
message
string
data
object