Welcome to the Bizappay API Reference! You can now start developing code to communicate with Bizappay. Register an account at https://www.bizappay.my/merchant.
\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6258355","collectionId":"33ada457-c538-4810-b301-2c73ed0cb0fd","publishedId":"SzmZdLp3","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-18T03:55:09.000Z"},"item":[{"name":"Generate Token","id":"daacdcdf-ddb8-4adf-abaa-644da60cadd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"We will not accept responsibility for loss of money due to improper use of the Bizappay API.
\n
[Required] - Get the API key from Settings > Profile page.
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/token","description":"API to generate token. This token will be used for each API request.
\n","urlObject":{"protocol":"https","path":["api","v3","token"],"host":["bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"30ef79ed-da3a-4b4c-af0d-eb8ac7329329","name":"Generate Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"},{"key":"name","value":"[Required] - Category name
\n","type":"text"},{"key":"description","value":"[Required] - Description of category. Max length 50 chars.
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/category/create","description":"API to create new category for bill. As an example, you may create a 'Rental' Category for bill related to rental.
\n","urlObject":{"protocol":"https","path":["api","v3","category","create"],"host":["bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"7af537ff-b84d-44f1-97eb-44d3a15f78e7","name":"Create Category","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"YjdhMjhlZDgyMGI5YTcxNmY2ZGRlNTRlMGIxMjNiM2QzZDg1N2FiM2YyMzcyZjdjYzI0NTM4OGViZjIxZGFlNg==","description":"[Required] - Value from Generate Token API","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"96248p75-5am4-wgn4-owul-i03907178Fk0","description":"[Required] - Get the API key from Settings > Profile page.","type":"text"},{"key":"name","value":"Sample category","description":"[Required] - Category name","type":"text"},{"key":"description","value":"This is sample category","description":"[Required] - Description of category. Max length 50 chars.","type":"text"}]},"url":"https://bizappay.my/api/v3/category/create"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"{\"status\":\"ok\",\"msg\":\"Success\",\"categoryCode\":\"4yWKX9EDjb\"}"}],"_postman_id":"5e6c48f1-22cf-4498-a7d5-4559e4cbdab5"},{"name":"Category List","id":"7e712281-8e18-4ce3-94f0-6c129b9f0d93","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/category","description":"List all your created bill category.
\n","urlObject":{"protocol":"https","path":["api","v3","category"],"host":["bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"546e73ba-5789-4cc9-984f-050c49e28e3e","name":"Category List","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"YjdhMjhlZDgyMGI5YTcxNmY2ZGRlNTRlMGIxMjNiM2QzZDg1N2FiM2YyMzcyZjdjYzI0NTM4OGViZjIxZGFlNg==","description":"[Required] - Value from Generate Token API","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"96248p75-5am4-wgn4-owul-i03907178Fk0","description":"[Required] - Get the API key from Settings > Profile page.","type":"text"}]},"url":"http://bizappay.my/api/v3/category"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"{\"status\":\"ok\",\"msg\":\"Success\",\"categories\":[{\"code\":\"yodpv1gg\",\"name\":\"General\"},{\"code\":\"m9fuwee1\",\"name\":\"myweb.my\"},{\"code\":\"j818L8p3\",\"name\":\"shop.website.asia\"}]}"}],"_postman_id":"7e712281-8e18-4ce3-94f0-6c129b9f0d93"},{"name":"Payment Bank List","id":"a3da32fc-561f-4815-bd7d-53745c0d72ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/payment-bank-list","description":"List all bank name, code and bank status (online/offline). The value from this API need to be pass when you create the bill through create bill API, if you plan to bypass our payment page.
\n","urlObject":{"protocol":"https","path":["api","v3","payment-bank-list"],"host":["bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"e5d820b6-8f59-4221-88f6-be7738d7b3e1","name":"Payment Bank List","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"YjdhMjhlZDgyMGI5YTcxNmY2ZGRlNTRlMGIxMjNiM2QzZDg1N2FiM2YyMzcyZjdjYzI0NTM4OGViZjIxZGFlNg==","description":"[Required] - Value from Generate Token API","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"96878p75-5ap4-wan4-owul-i03907178Fk0","description":"[Required] - Get the API key from Settings > Profile page.","type":"text"}]},"url":"https://bizappay.my/api/v3/payment-bank-list"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"{\"status\":\"ok\",\"msg\":\"Success\",\"banks\":[{\"code\":\"ABB0233\",\"name\":\"Affin Bank\",\"status\":\"offline\"},{\"code\":\"ABMB0212\",\"name\":\"Alliance Bank\",\"status\":\"online\"},{\"code\":\"AMBB0209\",\"name\":\"AmBank\",\"status\":\"online\"},{\"code\":\"BIMB0340\",\"name\":\"Bank Islam\",\"status\":\"online\"},{\"code\":\"BMMB0341\",\"name\":\"Bank Muamalat\",\"status\":\"online\"},{\"code\":\"BKRM0602\",\"name\":\"Bank Rakyat\",\"status\":\"online\"},{\"code\":\"BSN0601\",\"name\":\"BSN\",\"status\":\"online\"},{\"code\":\"BCBB0235\",\"name\":\"CIMB Clicks\",\"status\":\"online\"},{\"code\":\"HLB0224\",\"name\":\"Hong Leong Bank\",\"status\":\"online\"},{\"code\":\"HSBC0223\",\"name\":\"HSBC\",\"status\":\"online\"},{\"code\":\"KFH0346\",\"name\":\"KFH\",\"status\":\"online\"},{\"code\":\"MBB0228\",\"name\":\"Maybank2E\",\"status\":\"offline\"},{\"code\":\"MB2U0227\",\"name\":\"Maybank2U\",\"status\":\"online\"},{\"code\":\"OCBC0229\",\"name\":\"OCBC Bank\",\"status\":\"online\"},{\"code\":\"PBB0233\",\"name\":\"Public Bank\",\"status\":\"online\"},{\"code\":\"RHB0218\",\"name\":\"RHB Bank\",\"status\":\"online\"},{\"code\":\"SCB0216\",\"name\":\"Standard Chartered\",\"status\":\"online\"},{\"code\":\"UOB0226\",\"name\":\"UOB Bank\",\"status\":\"online\"}]}"}],"_postman_id":"a3da32fc-561f-4815-bd7d-53745c0d72ce"},{"name":"Create Bill","id":"4d726265-446f-47a1-a6c2-f06167f1ebed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"description":"[Required] - Get the API key from Settings > Profile page.
\n","key":"apiKey","type":"text","value":"[Required] - Get the Category Code from Bill Category List API
\n","key":"category","type":"text","value":"[Required] - Bill name will be displayed as bill title during payment. (min:5, max:100 chars)
\n","key":"name","type":"text","value":"[Required] - Bill amount in curency format (5.00). Bill amount should be more than 5.00
\n","key":"amount","type":"text","value":"[Required] - Put the payer's name here. (min:5, max:70 chars)
\n","key":"payer_name","type":"text","value":"[Required] - Payer's email address for payment notifications (max:50 chars)
\n","key":"payer_email","type":"text","value":"[Required] - Payer's phone number in case of inquiry. (max:20 chars)
\n","key":"payer_phone","type":"text","value":"[Optional] - Return url if you need the bill to be redirected to your page upon successful payment transaction.
\n","key":"webreturn_url","type":"text","value":""},{"description":"[Optional] - Bizappay will request this url and return billcode, billamount, billstatus (1-success, 2-pending, 3-failed, 4-no action), billinvoice (Bizappay's invoice number) and billtrans (transaction date/time) to be updated into your system. Please note that we will append those paramaters to your return url.
\n","key":"callback_url","type":"text","value":""},{"description":"[Optional] - Your own system reference number if you think it is required. You may use this reference number for future use.
\n","key":"ext_reference","type":"text","value":""},{"key":"splitArgs","value":"[Optional] - Pass this parameter in json format if you want to perform split. e.g:
\nPercentage split: {\"type\":1,\"split\":{\"split_user1_api_key\":10}}. 10% from the bill amount will be split to user1
\nFixed amount split: {\"type\":2,\"split\":{\"split_user1_api_key\":10}}\nMYR10 from bill amount will be split to user1
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/bill/create","description":"Every payment process begins from this point Create bill API
\n","urlObject":{"protocol":"https","path":["api","v3","bill","create"],"host":["bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"12c11229-c786-4b81-8085-9c0e9124c1e6","name":"Create Bill","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"},{"key":"category","value":"[Required] - Get the Category Code from Bill Category List API
\n","type":"text"},{"key":"name","value":"[Required] - Bill name will be displayed as bill title during payment
\n","type":"text"},{"key":"amount","value":"[Required] - Bill amount in curency format (5.00). Bill amount should be more than 5.00
\n","type":"text"},{"key":"payer_name","value":"[Required] - Put the payer's name here.
\n","type":"text"},{"key":"payer_email","value":"[Required] - Payer's email address for payment notifications.
\n","type":"text"},{"key":"payer_phone","value":"[Required] - Payer's phone number in case of inquiry.
\n","type":"text"},{"key":"bulk_count","value":"[Required] - For bulk payment. How many payment in this bill.
\n","type":"text"},{"key":"webreturn_url","value":"","description":"[Optional] - Return url if you need the bill to be redirected to your page upon successful payment transaction.
\n","type":"text"},{"key":"callback_url","value":"","description":"[Optional] - Bizappay will request this url and return billcode, billamount, billstatus (1-success, 2-pending, 3-failed, 4-no action), billinvoice (Bizappay's invoice number) and billtrans (transaction date/time) to be updated into your system. Please note that we will append those paramaters to your return url.
\n","type":"text"},{"key":"ext_reference","value":"","description":"[Optional] - Your own system reference number if you think it is required. You may use this reference number for future use.
\n","type":"text"}]},"url":"https://bizappay.my/api/v3/bulk-payment","description":"This API was designed specially for Bizapp.
\n","urlObject":{"protocol":"https","path":["api","v3","bulk-payment"],"host":["bizappay","my"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"b89b31a7-a7e1-40c9-a41e-7bdac2c9a297"},{"name":"Single SignOn","id":"3ab82211-4c5a-483f-88ad-f8dc606cf6a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"[Required]
\n","type":"text"},{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"}]},"url":"https://www.bizappay.my/api/v3/sso","description":"Call this API if you plan to redirect user to their Bizappay's account from your application.
\n","urlObject":{"protocol":"https","path":["api","v3","sso"],"host":["www","bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"d09812ec-679c-4856-a1f7-e18c7a46b89f","name":"Single SignOn","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"YjdhMjhlZDgyMGI5YTcxNmY2ZGRlNTRlMGIxMjNiM2QzZDg1N2FiM2YyMzcyZjdjYzI0NTM4OGViZjIxZGFlNg==","description":"[Required] - Value from Generate Token API","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"username","value":"myusername","description":"[Required]","type":"text"},{"key":"apiKey","value":"96878p75-5ap4-wan4-owul-i03907178Fk0","description":"[Required] - Get the API key from Settings > Profile page.","type":"text"}]},"url":"https://www.bizappay.my/api/v3/sso"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[],"cookie":[],"responseTime":null,"body":"{\"status\":\"ok\",\"msg\":\"validated\",\"url\":\"https:\\/\\/www.bizappay.my\\/sso-redirect?id=9c8f122200ac20b29ecffc5c11d96e005f044f016c2d4e4c71ea5d4f85abe26de48336391c13ccf8e0295cd63875653c0e023364682c47c93b7d72fef389749aTiSWzpCT~rUbJLuetLNoOSiLbjSurtTCM4hpBJ8EsOV5qSOGQWU2gDdQctwzRCbdz7vyW4GUmXrCzRPp5fKGu3Jiq~uC8irZRnqFpuJg2WtH00lzjaBwDxL8ysOsrx9v.nbLXzgGQjxyxJTxD5b6ly0yk7GCtfdhzke3kqfFH26r89NHoSKFF.peamnRgvci\"}"}],"_postman_id":"3ab82211-4c5a-483f-88ad-f8dc606cf6a8"},{"name":"Get Bill Information by Billcode","id":"6e20e235-eb0e-425a-a0bd-cc8c323a37ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Value from Generate Token API
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"apiKey","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"},{"key":"search_str","value":"[Required] - billcode e.g: OiU6DTopBL1
\n","type":"text"},{"key":"payment_status","value":"[Optional] - Pass this parameter to filter our payment by status (1 = success, 2 = pending, 3 = failed, 4 = no action/not paid)
\n","type":"text"},{"key":"latest","value":"[Optional] - true/false value to get the latest row of payment if the bill accept multipayment
\n","type":"text"}]},"url":"https://www.bizappay.my/api/v3/bill/info","description":"Use this API to get bill information including payments of the bill using billcode
\n","urlObject":{"protocol":"https","path":["api","v3","bill","info"],"host":["www","bizappay","my"],"query":[],"variable":[]}},"response":[{"id":"6145cc7c-f954-43b8-94de-a69b6acf394e","name":"Get Bill Information by Billcode","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"[Required] - Get the API key from Settings > Profile page.
\n","type":"text"},{"key":"search_str","value":"[Required] - Bizappay's invoice number e.g:BPXXXXXXXXXX..
\n","type":"text"}]},"url":"https://www.bizappay.my/api/v3/bill/info?search=invoice","description":"Use this API to get bill information including payments by invoice number (BPXXXXXXXX...)
\n","urlObject":{"protocol":"https","path":["api","v3","bill","info"],"host":["www","bizappay","my"],"query":[{"key":"search","value":"invoice"}],"variable":[]}},"response":[{"id":"83e1bd31-2c8e-4a23-9214-a2acfb9c3f62","name":"Get Bill Information by Invoice Number","originalRequest":{"method":"POST","header":[{"key":"Authentication","value":"