Query Parameters
Voucher id
Voucher memo or reference number
The account number used to pay for 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
- POSTCreate a new bank account
- GETRetrieve static accounts for a user
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
Retrieve voucher record
Copy
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'Copy
{
"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"
}
]
}Collect & Onramp
Retrieve voucher record
Retrieves an existing voucher record(s). When no query param is provided, all the voucher record for the merchant will be returned. If accountNumber field is provided in the query, all the voucher records associated with the given accountNumber for the merchant will be returned.
GET
/
v1
/
vouchers
Retrieve voucher record
Copy
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/vouchers \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'Copy
{
"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"
}
]
}⌘I