Query Parameters
Defaults to 1. This is the current page being requested relative to size of a page
The number of items to be retured per page
Voucher payment status
Available options:
paid, unpaid 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
Get multiple records
Copy
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/voucher/get-many \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'Copy
{
"success": true,
"message": "<string>",
"data": [
{
"id": "<string>",
"email": "<string>",
"amount": 123,
"fee": 123,
"currency": "<string>",
"feeBearer": "client",
"expectedAmount": 123,
"fullname": "<string>",
"paymentStatus": "paid",
"merchant": "<string>",
"memo": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"rateKey": "<string>",
"voucherCode": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"receivedAmount": 123,
"dateRedeemed": "2023-11-07T05:31:56Z",
"rate": 123
}
],
"meta": {
"nextPage": "<string>",
"prevPage": "<string>"
}
}Collect & Onramp
Get multiple records
Retrieves a collection of voucher records, sorted in descending order by their creation date.
GET
/
v1
/
voucher
/
get-many
Get multiple records
Copy
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/voucher/get-many \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'Copy
{
"success": true,
"message": "<string>",
"data": [
{
"id": "<string>",
"email": "<string>",
"amount": 123,
"fee": 123,
"currency": "<string>",
"feeBearer": "client",
"expectedAmount": 123,
"fullname": "<string>",
"paymentStatus": "paid",
"merchant": "<string>",
"memo": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"rateKey": "<string>",
"voucherCode": "<string>",
"paidAt": "2023-11-07T05:31:56Z",
"receivedAmount": 123,
"dateRedeemed": "2023-11-07T05:31:56Z",
"rate": 123
}
],
"meta": {
"nextPage": "<string>",
"prevPage": "<string>"
}
}⌘I