Collect & Onramp
Retrieve merchant record
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
Retrieve merchant record
Retrieves merchant record - username, email, callback URL, merchant logo, creditCurrency, API key expiry date-time
GET
/
v1
/
merchants
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/merchants \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'
{
"success": true,
"message": "<string>",
"data": {
"email": "<string>",
"username": "<string>",
"expires": "2023-10-03T09:21:05.197Z",
"logo": "https://www.example.com/favicon",
"creditCurrency": "NGN"
}
}
Response
200 - application/json
successful operation
Merchant email address
Merchant username
API key expiry date and time
Example:
"2023-10-03T09:21:05.197Z"
Merchant logo URL
Example:
"https://www.example.com/favicon"
Merchant's credit currency
Available options:
NGN
, USD
curl --request GET \
--url https://staging-vouchers.ventogram.com/api/v1/merchants \
--header 'X-Api-Key: <api-key>' \
--header 'X-Api-User: <api-key>'
{
"success": true,
"message": "<string>",
"data": {
"email": "<string>",
"username": "<string>",
"expires": "2023-10-03T09:21:05.197Z",
"logo": "https://www.example.com/favicon",
"creditCurrency": "NGN"
}
}