{"info":{"_postman_id":"bf839570-e5c1-473d-956a-c89f5812b328","name":"Merchant REST API","description":"This is the AvodaPay Single Page API. This allows you to generate a URL that you forward to consumers, from there they can deposit funds directly into your AvodaPay merchant wallet. They will be redirected to the url set as returnUrl and the status of the transaction will be sent to notifyUrl. status -> 0000 = success and status -> 0001 = fail. The fail case will occur when the consumer fails to complete the deposit process.\n\n# Authentication\nSecret Token issued as accessKey\n\n# Verification of Callback\nIf notifyURL isn't secured using https the accessKey can be sniffed. To prevent this a hash signature is generated using the callback parameters along with the accessKey. All requests to ../generate-url must be sent over https. It is advised merchants use a notifyUrl that contains ssl/tls.  \n\n {'paymentId': 'user:324123', 'amount': '1000', 'status': '0000', 'hmac': '1441559222E4F3AEDABBAF1C2A4CCCA8'}\n#### HMAC signature schema\n Using MD5 algorithm, example data string:\n \"paymentId=user:324123&amount=1000&status=1000&accesskey=2a8294ab2da0ff88e232321bcbe45f099a337a84b6fcbd2794ce45a76a362870\"\n\n\n# Callback Status Index\n \n* status = 0000 -> success\n* status = 0001 -> failure\n\n# Supported Banks Codes for CUP payment\n* ICBC\n* BOC\n* CNCB\n* BOS\n* CMBC\n* GDB\n* PSBC\n* ABC\n* CBHB","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json"},"item":[{"name":"Payment Processors","item":[{"name":"CUP Payment","id":"5644e3d6-c0fa-4ae5-8ca4-f54066117dad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"REQUIRED | Used to linked transaction in merchant system\n\n","key":"paymentId","type":"text","value":"325223423"},{"description":"REQUIRED | amount represented in (amount * 100)\n\n","key":"amount","type":"text","value":"1000"},{"description":"REQUIRED | Identifier of merchant found in merchant panel under api, one page api\n\n","key":"merchantId","type":"text","value":"1"},{"description":"REQUIRED | The url to return status of transaction (e.g) your url.\n\n","key":"notifyUrl","type":"text","value":"http://bob.avodapay.com/api/v1/one-page/testingNotifyUrl"},{"description":"REQUIRED| The url which the consumer gets redirected after a successful transaction\n\n","key":"returnUrl","type":"text","value":"https://secure.avodapay.com"},{"description":"REQUIRED | Secret token used to verify request. Found in merchant panel under api, one page api\n\n","key":"accessKey","type":"text","value":"key"},{"description":"REQUIRED | Process Selector","key":"mode","type":"text","value":"cup"},{"description":"REQUIRED | BankCode","key":"bankCode","type":"text","value":"ICBC"}]},"url":"https://secure.avodapay.com/api/v1/one-page/generate-url/","description":"**Description:** Initialisation of payment request\n"},"response":[{"id":"452e4519-db0f-4009-b348-d263d0aa2452","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"REQUIRED | Used to linked transaction in merchant system\n\n","key":"paymentId","type":"text","value":"325223423"},{"description":"REQUIRED | amount represented in (amount * 100)\n\n","key":"amount","type":"text","value":"1000"},{"description":"REQUIRED | Identifier of merchant found in merchant panel under api, one page api\n\n","key":"merchantId","type":"text","value":"1"},{"description":"REQUIRED | The url to return status of transaction (e.g) your url.\n\n","key":"notifyUrl","type":"text","value":"http://bob.avodapay.com/api/v1/one-page/testingNotifyUrl"},{"description":"REQUIRED| The url which the consumer gets redirected after a successful transaction\n\n","key":"returnUrl","type":"text","value":"https://secure.avodapay.com"},{"description":"REQUIRED | Secret token used to verify request. Found in merchant panel under api, one page api\n\n","key":"accessKey","type":"text","value":"key"},{"description":"REQUIRED | Process Selector","key":"mode","type":"text","value":"cup","disabled":true},{"description":"REQUIRED | BankCode","key":"bankCode","type":"text","value":"ICBC","disabled":true}]},"url":"https://secure.avodapay.com/api/v1/one-page/generate-url/"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Allow","value":"OPTIONS, POST"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Tue, 10 Mar 2020 00:52:11 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"770"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"PAYMENT URL"}],"_postman_id":"5644e3d6-c0fa-4ae5-8ca4-f54066117dad"},{"name":"Express Payment","id":"4cebcbde-1f77-4eb6-99de-ac7ce7d69ed4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"REQUIRED | Used to linked transaction in merchant system\n\n","key":"paymentId","type":"text","value":"325223423"},{"description":"REQUIRED | amount represented in (amount * 100)\n\n","key":"amount","type":"text","value":"1000"},{"description":"REQUIRED | Identifier of merchant found in merchant panel under api, one page api\n\n","key":"merchantId","type":"text","value":"1"},{"description":"REQUIRED | The url to return status of transaction (e.g) your url.\n\n","key":"notifyUrl","type":"text","value":"http://bob.avodapay.com/api/v1/one-page/testingNotifyUrl"},{"description":"REQUIRED| The url which the consumer gets redirected after a successful transaction\n\n","key":"returnUrl","type":"text","value":"https://secure.avodapay.com"},{"description":"REQUIRED | Secret token used to verify request. Found in merchant panel under api, one page api\n\n","key":"accessKey","type":"text","value":"key"},{"description":"REQUIRED | Process Selector","key":"mode","type":"text","value":"express"},{"key":"","type":"text","value":"","disabled":true}]},"url":"https://secure.avodapay.com/api/v1/one-page/generate-url/","description":"**Description:** Initialisation of payment request\n"},"response":[{"id":"7fad87e6-20fb-42fd-9c6b-b00729b5e7dc","name":"Example Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"description":"REQUIRED | Used to linked transaction in merchant system\n\n","key":"paymentId","type":"text","value":"325223423"},{"description":"REQUIRED | amount represented in (amount * 100)\n\n","key":"amount","type":"text","value":"1000"},{"description":"REQUIRED | Identifier of merchant found in merchant panel under api, one page api\n\n","key":"merchantId","type":"text","value":"1"},{"description":"REQUIRED | The url to return status of transaction (e.g) your url.\n\n","key":"notifyUrl","type":"text","value":"http://bob.avodapay.com/api/v1/one-page/testingNotifyUrl"},{"description":"REQUIRED| The url which the consumer gets redirected after a successful transaction\n\n","key":"returnUrl","type":"text","value":"https://secure.avodapay.com"},{"description":"REQUIRED | Secret token used to verify request. Found in merchant panel under api, one page api\n\n","key":"accessKey","type":"text","value":"key"},{"description":"REQUIRED | Process Selector","key":"mode","type":"text","value":"cup","disabled":true},{"description":"REQUIRED | BankCode","key":"bankCode","type":"text","value":"ICBC","disabled":true}]},"url":"https://secure.avodapay.com/api/v1/one-page/generate-url/"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Allow","value":"OPTIONS, POST"},{"key":"Content-Language","value":"en"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Date","value":"Tue, 10 Mar 2020 00:52:11 GMT"},{"key":"Server","value":"nginx/1.13.12"},{"key":"Vary","value":"Accept, Accept-Language, Cookie"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Content-Length","value":"770"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"PAYMENT URL"}],"_postman_id":"4cebcbde-1f77-4eb6-99de-ac7ce7d69ed4"}],"id":"847061aa-cc44-484d-b5da-5aa96a5b9dfa","event":[{"listen":"prerequest","script":{"id":"3d3d9a68-abcc-4e5e-a370-115b70d062c6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa754f6d-7b32-45b5-b3f7-5d1e1fc29016","type":"text/javascript","exec":[""]}}],"_postman_id":"847061aa-cc44-484d-b5da-5aa96a5b9dfa"}],"event":[{"listen":"prerequest","script":{"id":"ccedf6dd-58f2-46f7-a900-c919db6f2422","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"884d867a-0bc5-4f13-8514-45eca88adf94","type":"text/javascript","exec":[""]}}]}