{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3624055b-6ea3-4d95-b05c-374c4c143a1f","name":"Ventogram API","description":"Ventogram service allows users to create voucher by paying through bank transfer. This vouchers can be redeemed by the merchant through which the voucher is created\n\n|  | **Staging** | **Production** |\n| --- | --- | --- |\n| API Base URL | [https://staging-vouchers.ventogram.com](https://staging-vouchers.ventogram.com) | [https://vouchers.ventogram.com](https://vouchers.ventogram.com) |\n| redirect URL | [https://staging.ventogram.com](https://staging.ventogram.com) | [https://ventogram.com](https://ventogram.com) |\n\n### Quick start\n\n- Get access by filling the `Request Access Form` on [https://ventogram.com](https://ventogram.com)\n- Your API key will be sent to your email address. Use this api key in your request header as `x-api-key` and the provided username as `x-api-user`\n- Set up your logo and webhook URL using the [PATCH merchant endpoint](#f132b2e9-33df-41db-90b4-1d9582f2b2ec)  \n    _Webhook schema:_\n    \n\n``` json\n{\n  id: string;\n  email: string;\n  amount: number;\n  fullname: string;\n  currency: string;\n  feeBearer: string;\n  merchant: string;\n  paymentExpiresAt: Date;\n  memo?: string;\n}\n\n```\n\n- Redirect your users to your ventogram pay url https://staging.ventogram.com/voucher/pay?currency=NGN&amount=${amount}&fullname=${fullname}&email=${email}&user=${merchant}&callback=${callback} to create their voucher.  \n    The required params are:\n    - amount: The value of voucher to create\n    - fullname: The fullname of the voucher recipient\n    - email: The email of the voucher recipient\n    - merchant: Your merchant name\n    - callback: When a payment is successful the user would be redirected to redirect url with the `vouchercode` appended to the url like this `callback?vouchercode=samplecode` . When a user cancel's payment, the user would be redirected to the callback url as well.\n\nForming your ventogram pay url\n\n``` typescript\nconst redirectURL =  https://staging.ventogram.com\nconst callback = `${window.location.protocol}//${window.location.host}/redeemvoucher`\nconst params = new URLSearchParams()\nparams.append('amount', amount)\nparams.append('currency', 'NGN')\nparams.append('fullname', fullname)\nparams.append('email', email)\nparams.append('user', merchant)\nparams.append('callback', callback) \nconst url = `${redirectURL}?${params.toString()}`\n//You could redirect your users to the url just formed like so \nwindow.location.href = url\n\n```\n\n- Your users will be redirected back to the URL provided in `callback` when the payment is successful. Your callback url will be called with the voucher code as the value of voucher param\n- Call [Redeem voucher](#cab9b097-f281-4d6c-8294-724454e22327) endpoint to redeem the voucher for your user from your backend.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"19886917","collectionId":"3624055b-6ea3-4d95-b05c-374c4c143a1f","publishedId":"2s83mbpk6H","public":true,"publicUrl":"https://docs.ventogram.com","privateUrl":"https://go.postman.co/documentation/19886917-3624055b-6ea3-4d95-b05c-374c4c143a1f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.0","publishDate":"2022-10-12T17:50:36.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"documentation","id":"9f1a314b-50f0-4813-9aa7-e83e67022918","owner":"6893536","values":[{"key":"VENTOGRAM_BASE_URL","value":"https://staging-vouchers.ventogram.com/api","enabled":true,"type":"default"},{"key":"API_KEY","value":"secret","enabled":true,"type":"default"},{"key":"bizURL","value":"https://staging-biz.coinprofile.co","enabled":true,"type":"default"},{"key":"VENT_ADMIN_CODE","value":"code","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2f826cba9780f151bc03dfe6d2695bbd9b1c679d6b428ada2c16aada7eed2e47","favicon":"https://res.cloudinary.com/postman/image/upload/v1646560114/team/opjgtogc6t4zsp5pi9oj.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"documentation","value":"6893536-9f1a314b-50f0-4813-9aa7-e83e67022918"}],"canonicalUrl":"https://docs.ventogram.com/view/metadata/2s83mbpk6H"}