V-Pay enables you to easily accept online payments. The API is open to merchants licensed to operate in Rwanda. This documentation outlines different API end points and required parameters to make API calls. Visit https://vonsung.rw for more details.
\nStep 1: Send an application documents to info@vonsung.co.rw and we will create a merchant account for you. Application documents include a commitment letter, business incorporation certificate, contact details of the company and representative, and ID copy of company representative.
\nStep 2: Once the merchant account is created, login to your merchant portal and generate apiKey and apiUser
\nStep 3: Explore our API documentation and start testing
\nStep 4: If you are done, switch to LIVE mode, and update test credentials with LIVE credentials
\nNote:
\nIf you are using Postman to test the integration, remember to include the following in your request headers:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"đđģ Getting Started with V-Pay","slug":"getting-started-with-v-pay"}],"owner":"11499510","collectionId":"dd2ff2bf-b9c2-496c-bf86-4499b9bd6fa6","publishedId":"2s93mBxJtF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"2066ac"},"publishDate":"2023-06-01T15:46:32.000Z"},"item":[{"name":"Collection","item":[{"name":"sendRequestToPay","event":[{"listen":"test","script":{"id":"f8358c1c-6dcc-4508-a459-6ebf4b43f9c7","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8b6578d6-363a-4b67-823c-526fd030ae7c","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true,"connection":true,"accept":true,"accept-encoding":true}},"request":{"method":"POST","header":[{"key":"apiUser","value":"VPULCA5-E1LYO-ZYLMG"},{"key":"apiKey","value":"VPKf9mCtSBr5UO8pJuGd"}],"body":{"mode":"raw","raw":"{\n \"payer_phone\": \"0788604106\",\n \"external_id\": \"A403344545932357785\",\n \"payer_name\": \"Celestin\",\n \"amount\": 100,\n \"payer_email\": \"celestin@vonsung.co.rw\",\n \"payee_message\": \"Test\",\n \"send_receipt\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://pay.vonsung.rw/api/mtn_vPay","description":"You should always pass apiUser and apiKey as header parameters whenever you attempt to make an API call. The body barameters are passed as JSON.
To get your apiUser and apiKey, login to your merchant dashboard and go to API section, then copy your API user and API key.
Definition of body parameters:
\npayer_phone: also known as MSISDN is phone number where the request to pay will be sent.external_id: this is the transaction ID generated from your end (your integration platform). It is mainly used for the purpose of tracking the transaction status.payer_name: the name of payer being charged for a transaction.amount: integer value equavalent to the amount being charged (transaction amount).payer_email: the email of payer being charged for a transaction.payee_message: the payee note. Example: Purchase from Smarthiresend_receipt: boolean value (true if you want the payer to receive V-Pay receipt, false elsewhere)This request enables you to check the status of a transaction placed with V-Pay using the transaction ID (assigned by V-Pay).
\n","urlObject":{"path":["status"],"host":["https://pay.vonsung.rw/api"],"query":[],"variable":[]}},"response":[{"id":"60f7a8e7-1513-48fe-8962-f4f81b6ca101","name":"getStatusByTransactionId","originalRequest":{"method":"GET","header":[{"key":"apiUser","value":"VPULCA5-E1LYO-ZYLMG","type":"text"},{"key":"apiKey","value":"VPKf9mCtSBr5UO8pJuGd","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transaction_id\": \"VT20\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pay.vonsung.rw/api/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"Keep-Alive"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"access-control-allow-origin","value":"*"},{"key":"content-type","value":"application/json"},{"key":"access-control-allow-methods","value":"*"},{"key":"access-control-allow-headers","value":"Access-Control-Allow-Header, Content-Type, Access-Control-Allow-Methods, Authorizatipn, X-Requested-With"},{"key":"x-php-response-code","value":"200"},{"key":"cache-control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"pragma","value":"no-cache"},{"key":"content-length","value":"178"},{"key":"content-encoding","value":"br"},{"key":"vary","value":"Accept-Encoding,User-Agent"},{"key":"date","value":"Thu, 01 Jun 2023 15:14:56 GMT"},{"key":"server","value":"LiteSpeed"},{"key":"alt-svc","value":"h3=\":443\"; ma=2592000, h3-29=\":443\"; ma=2592000, h3-Q050=\":443\"; ma=2592000, h3-Q046=\":443\"; ma=2592000, h3-Q043=\":443\"; ma=2592000, quic=\":443\"; ma=2592000; v=\"43,46\""}],"cookie":[],"responseTime":null,"body":"{\n \"transaction_id\": \"VT20\",\n \"external_id\": \"A403344535785\",\n \"payer_name\": \"Celestin\",\n \"payer_phone\": \"250788604106\",\n \"transaction_date\": \"2023-06-01 03:04:11 pm\",\n \"payment_method\": \"mtnrw\",\n \"mode\": \"test\",\n \"currency\": \"RWF\",\n \"amount\": 50,\n \"status\": \"SUCCESSFUL\"\n}"}],"_postman_id":"9c0667fb-5507-4aa7-a147-e7ffd01e8ba1"},{"name":"getStatusByExternalTransactionId","event":[{"listen":"test","script":{"id":"7aa2767a-3295-4b25-a18e-8f92ca8168a5","exec":["// Describe the expected response shape with JSON Schema","// https://json-schema.org/","const expectedSchema = {"," \"type\": \"object\","," \"properties\": {"," \"data\": {"," \"type\": \"array\","," \"items\": {"," \"type\": \"object\","," \"properties\": {"," \"title\": {"," \"type\": \"string\""," },"," \"author\": {"," \"type\": \"string\""," },"," \"published\": {"," \"type\": \"integer\""," }"," },"," \"required\": ["," \"title\","," \"author\","," \"published\""," ]"," }"," }"," }","};","","// Test that the response matches the expected schema using built-in schema verification","pm.test('response matches JSON schema', () => {"," pm.response.to.have.jsonSchema(expectedSchema);","});"],"type":"text/javascript","packages":{}}}],"id":"a6de3014-8cc0-4238-b328-14afcc7aa4f7","protocolProfileBehavior":{"disabledSystemHeaders":{"user-agent":true,"accept":true,"accept-encoding":true,"connection":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"apiUser","value":"VPULCA5-E1LYO-ZYLMG","type":"text"},{"key":"apiKey","value":"VPKf9mCtSBr5UO8pJuGd","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"external_id\": \"VF3611095424\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pay.vonsung.rw/api/status","description":"Alternatively, you can check the transaction status using the external transaction ID which you passed as external_id when sending a request to pay.
This API enables integration with VONSUNG's secure checkout page, allowing you to process payments via MTN Mobile Money and card-based payments. This guide outlines the steps to send a POST request to the V-Pay API and handle the JSON response.
\nURL: https://pay.vonsung.rw/api/pay
To integrate with the VONSUNG-hosted checkout page, send a POST request to the endpoint with the required parameters in both the request headers and body.
\nPOST
Content-Type: application/jsonAuthorization: Bearer YOUR_ACCESS_TOKENThe disbursement API enables you transfer funds from your V-Pay account without logging in to your Merchant Account. The use cases include when you are developing an app that requires the users to initiate the disbursement/transfer request such as claiming rewards and bonuses.
\nThe disbursment process follow a series of quiet simple processes:
\n(GET) generateToken: this step involves generating a security token which is used for authentication in further processes. The dusbursement token is valid for only 30 min. The endpoint for generating token is disbursement/token and the request requires apiUser and apiKey to be passed from headers.(POST) createBeneficiary: a recipient should first be added to the recipients list before initiating the transfer. This API is used to accomplish such function and this API uses Bearer Token for authorization. A recipient_id is returned on a successful request, and this ID is used to process the transfer.(POST) transfer: this is the last step of the process. All you do is passing the recipient_id in body request, apiUser and apikey in headers, and athorize the transfer with the Bearer Token.The Exchange Rate API allows you to convert a specified amount from one currency to another. This guide outlines the steps to send a POST request to the Exchange Rate API and handle the JSON response.
\nURL: https://pay.vonsung.rw/api/exchange
To use the Exchange Rate API, send a POST request to the endpoint with the required headers and a JSON body.
\nPOST
Content-Type: application/json
apiUser: YOUR_API_USER
apiKey: YOUR_API_KEY