Collect & Onramp
Redeem existing unused voucher
Collect & Onramp
- GETRetrieve merchant account balance
- GETRetrieve merchant record
- PATCHUpdate merchant record
- POSTMake a mock payment
- GETRetrieves conversion rates
- GETRetrieve merchant transaction summary
- POSTCreate a new voucher payment
- GETRetrieve voucher record
- GETGet multiple records
- PATCHRedeem existing unused voucher
- PATCHRedeem and withdraw
- GETRetrieves conversion rates
- GETRetrieves minimum and maximum voucher amounts
Offramp
- POSTCreate api key
- POSTCreate payment
- GETGet a single payment
- GETGet a transaction
- GETGet current rates
- GETGet minimum amount allowed
- GETGet supported currencies
- GETGet supported cryptocurrencies and network
- GETResolve overpaid Transaction
- GETRetrieve subscribed webhook url
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- GETRetrieves a user's crypto wallet addresses
- PUTSubscribe to webhook
Payout
- GETGet current rates
- POSTWithdraw balance
- GETGet a transaction
- POSTResolve bank account
- GETGet minimum amount allowed
- GETRetrieve a list of supported banks
- GETRetrieve subscribed webhook url
- GETRetrieve user's account balance
- GETRetrieve user's transaction records
- GETRetrieve user's transaction summary
- PUTSubscribe to webhook
- POSTTransfer funds
- POSTWallet transfer
Collect & Onramp
Redeem existing unused voucher
Redeems an existing unused voucher
PATCH
/
v1
/
vouchers
curl --request PATCH \
--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>",
"voucherCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"currency": "NGN",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}
Body
application/json
Response
200
application/json
successful operation
The response is of type object
.
curl --request PATCH \
--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>",
"voucherCode": "<string>"
}'
{
"success": true,
"message": "<string>",
"data": {
"id": "<string>",
"email": "<string>",
"voucherCode": "<string>",
"amount": 123,
"fee": 123,
"wavedFee": 123,
"merchant": "<string>",
"currency": "NGN",
"feeBearer": "client",
"toAmount": 123,
"fromAmount": 123,
"fromCurrency": "<string>",
"toCurrency": "<string>",
"rate": 123,
"previousBalance": 123,
"currentBalance": 123
}
}