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
Redeem existing unused voucher
Redeems an existing unused voucher
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
Email that was used to create the voucher
Voucher code to be redeemed
Response
Voucher ID
Email that aws used to create the voucher
Voucher code to be redeemed
Voucher amount after fee deduction
The fee associated with voucher
Waved fee (if available)
username of the merchant that created the voucher
voucher payment currency
NGN, USD The bearer of voucher fee
client, merchant The amount in the currency that was converted to when conversion was done. If there's no conversion, this is the same as fromAmount.
The amount in the currency that was converted from when conversion was done. If there's no conversion, this is the same as toAmount.
The currency from which conversion was done. If there's no conversion, this is the same as toCurrency.
The currency to which conversion was done. If there's no conversion, this is the same as fromCurrency.
The exchange rate that was used for conversion when conversion was done. If there's no conversion, the value is 1.
Merchant's balance before redeeming voucher
Merchant's balance after redeeming voucher
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
}
}