Using the image_id that is returned in the response of the /objectlist call, the image can be retrieved from the server. The image data is encoded as Base64.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["retrieve_image"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"23fba31b-7f83-4a2c-bd95-32365fc5cf46","name":"200 Image list retrieved","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerAirtime and Data pins also known as voucher sales are done through the pin_airtime_data method.
\nTo better describe prepaid_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\nThe voucher detail of the response typically include the fields:
\n- \n
- provider \n
- description \n
- external_reference \n
- serial_number \n
- pin_number \n
- expiry_date \n
- instructions \n
The tx_status will always be Delivered in the response.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["pin_airtime_data"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"668082c3-9016-4f04-9065-90fcc31e439e","name":"200: Successful transaction","originalRequest":{"method":"POST","header":[{"description":"Not needed. Only included for the Postman mock server setup.","key":"x-mock-response-code","value":"200"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"948b30e4-86c4-4981-ac51-04b4392d2e0a\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"21a4371e-d432-427a-9bb1-f2161393ed11\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 58,\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://extapi.finclude.co.za/api/v2/pin_airtime_data","description":"Airtime and Data pins also known as voucher sales are done through the pin_airtime_data method.\n\nTo better describe prepaid_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\n\nThe voucher detail of the response typically include the fields:
\n\n+ provider\n+ description\n+ external_reference\n+ serial_number\n+ pin_number\n+ expiry_date\n+ instructions
\n\nThe tx_status will always be Delivered in the response."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"Success\",\n \"req_session_id\": \"bd75431c-06d9-4649-9cfb-e6fdc3beb09c\",\n \"req_device_id\": \"AB00932\",\n \"req_transaction_id\": \"{{your_unique_transaction_id}}\",\n \"req_date_time\": \"2020-12-10T12:50:00.001Z\",\n \"req_platform\": \"POS\"\n },\n \"transaction_detail\": {\n \"tx_date_time\": \"2020-12-10T12:53:00.001Z\",\n \"tx_log_id\": 142890,\n \"tx_status\": \"Delivered\"\n },\n \"voucher_detail\": {\n \"provider\": \"BeMobile\",\n \"description\": \"BEMOBILE P20\",\n \"external_reference\": \"16746333\",\n \"serial_number\": \"20792248\",\n \"pin_number\": \"2027993495970940\",\n \"expiry_date\": \"2021-03-15T00:00:00.00Z\",\n \"instructions\": [\n \"Dail *135*mobile number*pin number #\",\n \"to recharged\"\n ]\n },\n \"transaction_value\": {\n \"country_code\": \"BW\",\n \"currency\": \"Pula\",\n \"value_type\": \"fixed\",\n \"denomination\": \"smallestSubunit\",\n \"transaction_value\": 2000,\n \"vat_inclusive\": \"Incl 12% VAT\"\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}"},{"id":"0ac903b1-878f-47d2-8dfc-02d1b2f01499","name":"400 Error: Bad request","originalRequest":{"method":"POST","header":[{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_token\": \"{{id_token}}\",\r\n \"req_session_id\": \"a0ac1948-9874-4f11-b9f7-71ebc89039c0\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_transaction_id\": \"{{your_unique_transaction_id}}\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": {{api_tx_object_id}},\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"//pin_airtime_data","description":"Airtime and Data pins also known as voucher sales are done through the pin_airtime_data method.
\n\nTo better describe prepaid_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\n\nThe voucher detail of the response typically include the fields:
\n\n+ provider\n+ description\n+ external_reference\n+ serial_number\n+ pin_number\n+ expiry_date\n+ instructions
\n\nThe tx_status will always be Delivered in the response."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"2046b2d6-e734-490f-97f1-415e22868b3b","name":"401 Error: Unauthorised","originalRequest":{"method":"POST","header":[{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_token\": \"{{id_token}}\",\r\n \"req_session_id\": \"705addd2-cfe2-4076-aad7-aaf1528ece3f\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_transaction_id\": \"{{your_unique_transaction_id}}\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": {{api_tx_object_id}},\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"//pin_airtime_data","description":"Airtime and Data pins also known as voucher sales are done through the pin_airtime_data method.
\n\nTo better describe prepaid_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\n\nThe voucher detail of the response typically include the fields:
\n\n+ provider\n+ description\n+ external_reference\n+ serial_number\n+ pin_number\n+ expiry_date\n+ instructions
\n\nThe tx_status will always be Delivered in the response."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid authorization token.\"\n }\n}"},{"id":"ea751781-0b1e-4c56-a2b1-a390e60b0a24","name":"500 Error: Internal server error","originalRequest":{"method":"POST","header":[{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_token\": \"{{id_token}}\",\r\n \"req_session_id\": \"4f90afc1-9d3b-4192-8752-a7b44c4e0285\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_transaction_id\": \"{{your_unique_transaction_id}}\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": {{api_tx_object_id}},\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}\r\n\r\n","options":{"raw":{"language":"json"}}},"url":"//pin_airtime_data","description":"Airtime and Data pins also known as voucher sales are done through the pin_airtime_data method.
\n\nTo better describe prepaid_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\n\nThe voucher detail of the response typically include the fields:
\n\n+ provider\n+ description\n+ external_reference\n+ serial_number\n+ pin_number\n+ expiry_date\n+ instructions
\n\nThe tx_status will always be Delivered in the response."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experience an error.\"\n }\n}"}],"_postman_id":"c097d544-9a4f-4cd8-8ca1-0c5405350a45"},{"name":"pinless_airtime_data","event":[{"listen":"test","script":{"id":"022f0bc3-7077-4e95-877f-cc55411624bc","exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (pm.response.code !== 500) {\r"," if (jsonData.meta.response_code == 0) {\r"," \r"," postman.setEnvironmentVariable(\"org_req_transaction_id\", jsonData.meta.req_transaction_id);\r"," postman.setEnvironmentVariable(\"org_tx_log_id\", jsonData.transaction_detail.tx_log_id);\r","\r"," };\r","}\r",""],"type":"text/javascript","packages":{}}}],"id":"98b5bd9c-12eb-4726-bf38-bf9d5c0e0e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"req_platform\": \"POS\",\n \"req_store_id\": \"\",\n \"req_date_time\": \"2024-02-26T09:43:40.0091632+02:00\",\n \"req_device_id\": \"0\",\n \"req_transaction_id\": \"da1e2006-8e77-448a-9b1b-564cc86642a6\",\n \"req_session_id\": \"14675d73-655e-4f35-a959-00f3880cb07b\",\n \"api_tx_object_id\": 668,\n \"parameters\": {\n \"msisdn\": \"72216623\",\n \"transaction_value\": 1000\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//pinless_airtime_data","description":"
Pinless irtime and Data are done through the pinless_airtime_data method. The response will not contain any tokens
\nTo better describe pinless_airtime_data, a number of example calls are shown with their respective responses. The calls are for different utility supplier products. The requester needs to send the standard requester detail as well as the unique api_tx_object_id and optional requester_data in the post request.
\nThe voucher detail of the response typically include the fields:
\nThe tx_status will always be Delivered in the response.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["pinless_airtime_data"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"4edb1e4f-6269-4f51-b9cb-c62f47075c91","name":"200: Successful transaction","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis can be used to fetch relevant information about any account (mobile wallet, bank account, gift cards, etc). This is typically used in conjunction with /make_payment and /receive_payment.
\nThe transaction can have only one of two responses:
\n- \n
- Success: the lookup was processed and information for the account could be found. \n
- Failed. If the transaction failed because information for the account could not be found, or the account is inactive/blocked, this will be indicated in the structured error message which will contain an error_code and an error_description. \n
\n\nNote: account_identification => This defines the \"account number\". Depending on the product, the \"account_number\" can be a bank account number, a msisdn, a gift card number, etc.
\n
Typically the provider test environments have a very limited set of test accounts available. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mprovider to call, based on the account number received.\n For this reason the Finclude B2B API has mock test numbers available.
\nMore information regarding test account numbers that are available can be found here: Additional B2B API information
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["account_verification"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"fe58f7cd-3692-4d99-96cf-f6db5fd4c358","name":"200: Successful payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis can be used to deposit/transfer funds in an account (mobile wallet, bank account, gift cards, etc).
\nThe transaction can have only one of two responses:
\n- \n
- Success: the deposit/transfer was processed and information for the account could be found. \n
- Failed. If the transaction it will be indicated in the structured error message which will contain an error_code and an error_description. \n
\n\nNote: account_identification => This defines the \"account number\". Depending on the product, the \"account_number\" can be a bank account number, a msisdn, a gift card number, etc.
\n
Typically the provider test environments have a very limited set of test accounts available. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which provider to call, based on the account number received.\n For this reason the Finclude B2B API has mock test numbers available.
\nMore information regarding test account numbers that are available can be found here: Additional B2B API information
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["make_payment"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"7b63e109-25ad-49c2-b4d8-881bdd5893c1","name":"200: Successful deposit/transfer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis can be used to withdraw/transfer funds from an account (mobile wallet, bank account, gift cards, etc).
\nThe transaction can have only one of two responses:
\n- \n
- Success: the withdrawel/transfer was processed and was successful. \n
- Failed. If the transaction it will be indicated in the structured error message which will contain an error_code and an error_description. \n
\n\nNote: account_identification => This defines the \"account number\". Depending on the product, the \"account_number\" can be a bank account number, a msisdn, a gift card number, etc.
\n
Typically the provider test environments have a very limited set of test accounts available. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which provider to call, based on the account number received.\n For this reason the Finclude B2B API has mock test numbers available.
\nMore information regarding test account numbers that are available can be found here: Additional B2B API information
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["receive_payment"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"0992a829-11f8-4599-9aea-ec0078f4034e","name":"200: Successful withdrawel/transfer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe msisdn number and sale value needs to form part of the POST request. The msisdn must be sent without the country code included.
\nThe transaction can have only one of two responses:
\n- \n
- Success: the payment was processed and no issues encountered. \n
- Failed. If the transaction failed because the owner of the msisdn has rejected the transaction, this will be indicated in the structured error message which will contain an error_code of 200027 and an error_description of 'Payment approval rejected'. \n
\n\nNote: msisdn => The mobile number
\n
Typically the mobile money provider test environments have a very limited set of test numbers (msisdn) available and often enforces the currency that has to be used. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mobile money provider to call, based on the msisdn sent through.
For this reason the Finclude B2B API has mock test numbers available. Each of these can simply be prefixed with the provider specific msisdn prefixes.
More information regarding the test msisdn number that are available, the lenth of the msisdn and the prefixes used for each county can be found here:Additional B2B API information
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["mobile_pay"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"72e9071e-9196-4acf-8e1a-e0b178616780","name":"200: Successful payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"Not needed. Only included for the Postman mock server setup.","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"811ed45f-f8fa-48fd-8f39-65c45f891c6d\",\r\n \"req_device_id\": \"XXX1234\",\r\n \"req_store_id\": \"store001\",\r\n \"req_transaction_id\": \"714effa6-87f5-41d0-90ef-0ab9c5857a89\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 3,\r\n \"parameters\": {\r\n \"msisdn\": \"0963123454\",\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://extapi.finclude.co.za/api/v2/mobile_pay","description":"The msisdn number and sale value needs to form part of the POST request. The msisdn must be sent without the country code included.\n\nThe transaction can have only one of two responses:\n\n* Success: the payment was processed and no issues encountered.\n* Failed. If the transaction failed because the owner of the msisdn has rejected the transaction, this will be indicated in the structured error message which will contain an error_code of 200027 and an error_description of 'Payment approval rejected'.\n \n\n> **Note:** msisdn => The mobile number\n\nTypically the mobile money provider test environments have a very limited set of test numbers (msisdn) available and often enforces the currency that has to be used. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mobile money provider to call, based on the msisdn sent through. \nFor this reason the Finclude B2B API has mock test numbers available. Each of these can simply be prefixed with the provider specific msisdn prefixes.\n\nMore information regarding the test msisdn number that are available, the lenth of the msisdn and the prefixes used for each county can be found here:Additional B2B API information
"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"Success\",\n \"req_session_id\": \"8a801fab-8c39-4a46-9a38-f6c2a2356669\",\n \"req_device_id\": \"928-123-765\",\n \"req_transaction_id\": \"78245234\",\n \"req_platform\": \"WEB\",\n \"req_date_time\": \"2021-01-12T09:36:55.012+02:00\"\n },\n \"transaction_detail\": {\n \"tx_date_time\": \"2021-01-12T09:36:57.005+02:00\",\n \"tx_log_id\": 1677131,\n \"tx_status\": \"Delivered\"\n },\n \"payment_detail\": {\n \"value_store\": \"MTN MoMo\",\n \"value_store_id\": 998,\n \"value_store_ref\": \"1415196800\",\n \"msisdn\": \"46733123454\"\n },\n \"transaction_value\": {\n \"currency\": \"EUR\",\n \"tendered_value\": 10000\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}"},{"id":"f7abaf71-a2c5-4401-af06-a3b9721908d3","name":"400 Error: Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"6d2d22fb-a3ba-4b15-905a-b1d40b14344b\",\r\n \"req_device_id\": \"XXX1234\",\r\n \"req_store_id\": \"store001\",\r\n \"req_transaction_id\": \"8c99a411-3476-4c41-af6a-e11171d01009\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 3,\r\n \"parameters\": {\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//mobile_pay","description":"The msisdn number and sale value needs to form part of the POST request. The msisdn must be sent without the country code included.\n\nThe transaction can have only one of two responses:\n\n* Success: the payment was processed and no issues encountered.\n* Failed. If the transaction failed because the owner of the msisdn has rejected the transaction, this will be indicated in the structured error message which will contain an error_code of 200027 and an error_description of 'Payment approval rejected'.\n \n\n> **Note:** msisdn => The mobile number\n\nTypically the mobile money provider test environments have a very limited set of test numbers (msisdn) available and often enforces the currency that has to be used. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mobile money provider to call, based on the msisdn sent through. \nFor this reason the Finclude B2B API has mock test numbers available. Each of these can simply be prefixed with the provider specific msisdn prefixes.\n\nMore information regarding the test msisdn number that are available, the lenth of the msisdn and the prefixes used for each county can be found here:Additional B2B API information
"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"d6ee6d4b-6122-4fc6-b8b7-2565cc574483","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"e0e65b87-7ecc-4d80-a073-87f3b8e0f7fd\",\r\n \"req_device_id\": \"XXX1234\",\r\n \"req_store_id\": \"store001\",\r\n \"req_transaction_id\": \"60087821-26c0-4af8-9978-cdd589ff48c2\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 3,\r\n \"parameters\": {\r\n \"msisdn\": \"0963123454\",\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//mobile_pay","description":"The msisdn number and sale value needs to form part of the POST request. The msisdn must be sent without the country code included.\n\nThe transaction can have only one of two responses:\n\n* Success: the payment was processed and no issues encountered.\n* Failed. If the transaction failed because the owner of the msisdn has rejected the transaction, this will be indicated in the structured error message which will contain an error_code of 200027 and an error_description of 'Payment approval rejected'.\n \n\n> **Note:** msisdn => The mobile number\n\nTypically the mobile money provider test environments have a very limited set of test numbers (msisdn) available and often enforces the currency that has to be used. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mobile money provider to call, based on the msisdn sent through. \nFor this reason the Finclude B2B API has mock test numbers available. Each of these can simply be prefixed with the provider specific msisdn prefixes.\n\nMore information regarding the test msisdn number that are available, the lenth of the msisdn and the prefixes used for each county can be found here:Additional B2B API information
"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"e09829a4-585c-49fb-92c0-6dd2c5eab9f0","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"dab13bd9-be9c-4aac-9282-62f1b636000a\",\r\n \"req_device_id\": \"XXX1234\",\r\n \"req_store_id\": \"store001\",\r\n \"req_transaction_id\": \"76d5784d-feb2-4b0c-b44b-0c9a181cd516\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 3,\r\n \"parameters\": {\r\n \"msisdn\": \"0963123454\",\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//mobile_pay","description":"The msisdn number and sale value needs to form part of the POST request. The msisdn must be sent without the country code included.\n\nThe transaction can have only one of two responses:\n\n* Success: the payment was processed and no issues encountered.\n* Failed. If the transaction failed because the owner of the msisdn has rejected the transaction, this will be indicated in the structured error message which will contain an error_code of 200027 and an error_description of 'Payment approval rejected'.\n \n\n> **Note:** msisdn => The mobile number\n\nTypically the mobile money provider test environments have a very limited set of test numbers (msisdn) available and often enforces the currency that has to be used. This is obviously not ideal to test the Finclude B2B API since the Finclude B2B API determines which mobile money provider to call, based on the msisdn sent through. \nFor this reason the Finclude B2B API has mock test numbers available. Each of these can simply be prefixed with the provider specific msisdn prefixes.\n\nMore information regarding the test msisdn number that are available, the lenth of the msisdn and the prefixes used for each county can be found here:Additional B2B API information
"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experienced an error.\"\n }\n}"}],"_postman_id":"4b7555fc-a5ae-4fca-a03b-a2af29e32195"},{"name":"prepaid_utility_lookup","event":[{"listen":"test","script":{"id":"59b77b32-28ba-4125-a4be-59fc7daedfc6","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"0382a72e-88f5-4cfa-ad8c-6c7fed3d2b6b","exec":[""],"type":"text/javascript","packages":{}}}],"id":"f18c8ddf-badf-4350-ab43-a5049529da0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"019a1090-3e3c-4164-86bd-dc7926c66e91\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"ba833053-c83b-414f-97f5-f39916602688\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"api_tx_object_id\": 282,\n \"parameters\": {\n \"meter_number\": \"04040404040\"\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}"},"url":"//prepaid_utility_lookup","description":"Most utilities sales works in a two-step manner in which confirmation of the meter owner is needed before the sale is done. The typical api calls used are depicted below.
\n\n\nNote: \nEven though it might not be forced to perform a prepaid_utility_lookup before a sale is done at all utility providers, it is highly recommended to do so.
\n
The parameter sale_apk_tx_object is returned during the lookup to assist in the two step process.
\nThe possibly utility_type is
\n- \n
- Electricity \n
- Water \n
- Gas \n
The utility meter number needs to be provided in the request.
\nThe details of the meter number holder are then returned. Typically so that the customer can confirm the correct meter number were entered.
\nNOTE: For meter numbers that can be used for testing see the /prepaid_utility_sale section
\nThe response has a generic structure, therefore some fields may return empty as the specific utilities provider might not require the detail to show.
\nAdditional examples of possible responses has been provided below together with the calls that can be done against the mock server to get these responses.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["prepaid_utility_lookup"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"1a7eb207-da3a-4e87-b67d-d45d7b20570c","name":"200: Successful lookup","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"9c551186-79ff-4d5b-b1a6-08cebcc44998\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"cec17eb5-afff-4b2f-879c-7b1425e9e9c7\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"api_tx_object_id\": 282,\n \"parameters\": {\n \"meter_number\": \"04040404040\"\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:8080/api/b2b/v3/prepaid_utility_lookup","description":"Most utilities sales works in a two-step manner in which confirmation of the meter owner is needed before the sale is done. The typical api calls used are depicted below.\n\n
\n\n> **Note:** \nEven though it might not be forced to perform a prepaid_utility_lookup before a sale is done at all utility providers, it is highly recommended to do so.
\n\nThe parameter sale_apk_tx_object is returned during the lookup to assist in the two step process.
\n\nThe possibly utility_type is\n+ Electricity\n+ Water\n+ Gas\n\nThe utility meter number needs to be provided in the request.
\n\nThe details of the meter number holder are then returned. Typically so that the customer can confirm the correct meter number were entered.
\n\nNOTE: For meter numbers that can be used for testing see the /prepaid_utility_sale section
\n\nThe response has a generic structure, therefore some fields may return empty as the specific utilities provider might not require the detail to show.
\n\nAdditional examples of possible responses has been provided below together with the calls that can be done against the mock server to get these responses."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"SUCCESS\",\n \"req_session_id\": \"fe6d3e2d-0f8b-4e5d-a843-9ffa162a1f12\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"e73670ab-a31e-44fb-ae9b-1a886e0e2992\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\"\n },\n \"transaction_detail\": {\n \"tx_date_time\": \"2024-01-04T18:07:05.550+02:00\",\n \"tx_log_id\": 59017180,\n \"tx_status\": \"DELIVERED\"\n },\n \"voucher_detail\": {\n \"provider\": \"BPC\",\n \"description\": \"\",\n \"external_reference\": \"\",\n \"utility_type\": \"Electricity\",\n \"munic\": \"\",\n \"SGC\": \"\",\n \"meter_number\": \"04040404040\",\n \"account_holder\": \"Default Test\",\n \"account_type\": \"\",\n \"address\": \"1 TEST BLOCK\",\n \"location_ref\": \"\",\n \"can_vend\": true,\n \"min_vend\": 0,\n \"max_vend\": 100000,\n \"denomination\": \"smallestSubunit\",\n \"outstanding\": 0\n },\n \"sale_api_tx_object_id\": \"283\",\n \"previous_api_tx_object_id\": \"0\",\n \"next_api_tx_object_id\": \"283\",\n \"next_api_tx_object\": {\n \"api_tx_object_id\": 283,\n \"previous_api_tx_object_id\": 282,\n \"next_api_tx_object_id\": 0,\n \"category\": \"Electricity\",\n \"provider\": \"Botswana Power Corporation (BPC)\",\n \"description\": \"BPC Electricity Prepaid Sale\",\n \"image_id\": 83,\n \"method_name\": \"prepaid_utility_sale\",\n \"country\": \"Botswana\",\n \"country_code\": \"BW\",\n \"currency\": \"BWP\",\n \"denomination\": \"smallestSubunit\",\n \"value_type\": \"variable\",\n \"transaction_value\": 0,\n \"menu_group\": \"Sale\",\n \"parent_menu\": 15,\n \"menu_parameters\": [\n {\n \"param_key\": \"METER_NUMBER\",\n \"param_display_text\": \"Meter Number\",\n \"param_sequence\": 3,\n \"param_type\": \"NUMERIC\",\n \"param_is_currency\": false,\n \"param_min_value\": 11,\n \"param_valid_expression\": \"^\\\\d{11}$\"\n },\n {\n \"param_key\": \"SALE_VALUE\",\n \"param_display_text\": \"Value (BWP)\",\n \"param_sequence\": 4,\n \"param_type\": \"NUMERIC\",\n \"param_is_currency\": true,\n \"param_min_value\": 0,\n \"param_valid_expression\": \"^\\\\d+(\\\\.\\\\d{1,2})?$\"\n }\n ],\n \"api_call_injection\": \"\\\"parameters\\\": {\\\"meter_number\\\": \\\"< \n\n \n\n> **Note:** \nEven though it might not be forced to perform a prepaid_utility_lookup before a sale is done at all utility providers, it is highly recommended to do so. \n\nThe parameter sale_apk_tx_object is returned during the lookup to assist in the two step process. \n\nThe possibly utility_type is\n+ Electricity\n+ Water\n+ Gas\n\nThe utility meter number needs to be provided in the request. \n\nThe details of the meter number holder are then returned. Typically so that the customer can confirm the correct meter number were entered. \n\nNOTE: For meter numbers that can be used for testing see the /prepaid_utility_sale section \n\nThe response has a generic structure, therefore some fields may return empty as the specific utilities provider might not require the detail to show. \n\nAdditional examples of possible responses has been provided below together with the calls that can be done against the mock server to get these responses."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"627af2e3-5951-42e3-9a56-4b7e84e95a79","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"24bd3704-c54c-40ec-bdc6-79b5d3c5196b\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"6354ac80-50ad-4f7e-bc6a-16b7c9472d0c\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"api_tx_object_id\": 282,\n \"parameters\": {\n \"meter_number\": \"04040404040\"\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"//prepaid_utility_lookup","description":"Most utilities sales works in a two-step manner in which confirmation of the meter owner is needed before the sale is done. The typical api calls used are depicted below. \n\n \n\n> **Note:** \nEven though it might not be forced to perform a prepaid_utility_lookup before a sale is done at all utility providers, it is highly recommended to do so. \n\nThe parameter sale_apk_tx_object is returned during the lookup to assist in the two step process. \n\nThe possibly utility_type is\n+ Electricity\n+ Water\n+ Gas\n\nThe utility meter number needs to be provided in the request. \n\nThe details of the meter number holder are then returned. Typically so that the customer can confirm the correct meter number were entered. \n\nNOTE: For meter numbers that can be used for testing see the /prepaid_utility_sale section \n\nThe response has a generic structure, therefore some fields may return empty as the specific utilities provider might not require the detail to show. \n\nAdditional examples of possible responses has been provided below together with the calls that can be done against the mock server to get these responses."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"6980606c-785a-434a-9c41-4e779cd9c40f","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"881a6fe8-0c69-4e58-8348-2f5e02d2bc61\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"3ba018e9-88c1-4b0a-9ca7-57cd845afbff\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"api_tx_object_id\": 282,\n \"parameters\": {\n \"meter_number\": \"04040404040\"\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"//prepaid_utility_lookup","description":"Most utilities sales works in a two-step manner in which confirmation of the meter owner is needed before the sale is done. The typical api calls used are depicted below. \n\n \n\n> **Note:** \nEven though it might not be forced to perform a prepaid_utility_lookup before a sale is done at all utility providers, it is highly recommended to do so. \n\nThe parameter sale_apk_tx_object is returned during the lookup to assist in the two step process. \n\nThe possibly utility_type is\n+ Electricity\n+ Water\n+ Gas\n\nThe utility meter number needs to be provided in the request. \n\nThe details of the meter number holder are then returned. Typically so that the customer can confirm the correct meter number were entered. \n\nNOTE: For meter numbers that can be used for testing see the /prepaid_utility_sale section \n\nThe response has a generic structure, therefore some fields may return empty as the specific utilities provider might not require the detail to show. \n\nAdditional examples of possible responses has been provided below together with the calls that can be done against the mock server to get these responses."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experienced an error.\"\n }\n}"}],"_postman_id":"f18c8ddf-badf-4350-ab43-a5049529da0e"},{"name":"prepaid_utility_sale","event":[{"listen":"test","script":{"id":"28124286-0877-4482-9096-923a8dc4bb40","exec":["var jsonData = JSON.parse(responseBody);\r","\r","if (pm.response.code !== 500) {\r"," if (jsonData.meta.response_code == 0) {\r"," \r"," postman.setEnvironmentVariable(\"org_req_transaction_id\", jsonData.meta.req_transaction_id);\r"," postman.setEnvironmentVariable(\"org_tx_log_id\", jsonData.transaction_detail.tx_log_id);\r","\r"," };\r","}\r",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"20a26ed9-9659-44a4-81d2-ae6706ca847a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"b76d6765-aeec-4ecc-b8c6-c8fd49c28e17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"9c2eef01-44c8-4808-8537-1c907e77c487\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"d0c0c787-b8fc-4dbd-a301-200f2674cb83\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"api_tx_object_id\": 283,\n \"parameters\": {\n \"meter_number\": \"04040404040\",\n \"transaction_value\": 10000\n },\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}"},"url":"//prepaid_utility_sale","description":" The meter number and sale value needs to form part of the POST request. Should lookup be a requirement, the lookup's transaction log id should be included as well. As the response is generic through different providers and countries, some fields maybe returned emptied depending on the requirements of the Utility provider. The provider detail section gives information regarding the Utility Provider which might be legally required to be printed on any slip rendered on behalf of the utility provider. In the account detail section, the information with regards to the account holder who is linked to the meter number is returned. The meter detail section provide the details of the specific meter. meter_number: The meter number The following meter numbers can be used for testing for BPC (Botswana Power Corporation): For failed responses use the following The following meter numbers can be used for testing for LEC (Lesotho Electricity Corporation): sgc: Supplier Group Code krn: Key Revision Number ti: Tarrif Index alg: Token Generating Algorithme tt: Token Technology Code The tendered amount are not necessary the value of the utility purchased, this is because the different utility providers may be required by law to recover some additional charges. The tendered breakdown is returned as an array, the description will indicate which charge it is and the value the amount charged for it. A list of possible descriptions are: The token details section return an array in which each token is specified with its type, token number and units, if applicable. \n\nAs the response is generic through different providers and countries, some fields maybe returned emptied depending on the requirements of the Utility provider. \n\nThe provider detail section gives information regarding the Utility Provider which might be legally required to be printed on any slip rendered on behalf of the utility provider.\n\n+ name: The utility provider name\n+ vat_number: The VAT number of the provider\n+ address: The address of the provider\n+ contact_number: The contact number of the provider \n\nIn the account detail section, the information with regards to the account holder who is linked to the meter number is returned. \n\nThe meter detail section provide the details of the specific meter. \n\n+ meter_number: The meter number\n> * The following meter numbers can be used for testing for BPC (Botswana Power Corporation):\n> * For a successful response use: 04040404040\n>\n> * For failed responses use the following\n> * 04040404347 - error message: blocked meter number\n> * 04040404438 - error message: blocked account number\n> * 04040404768 - error message: blocked customer number\n> * 04040406698 - error message: Meter number not found or disconnected meter number\n>\n> * The following meter numbers can be used for testing for LEC (Lesotho Electricity Corporation):\n> * 07091234562\n> * 07000001102\n> * 07000000674\n> * 1234567\n> * 07000000013\n\n+ sgc: Supplier Group Code\n+ krn: Key Revision Number\n+ ti: Tarrif Index\n+ alg: Token Generating Algorithme\n+ tt: Token Technology Code \n\nThe tendered amount are not necessary the value of the utility purchased, this is because the different utility providers may be required by law to recover some additional charges. The tendered breakdown is returned as an array, the description will indicate which charge it is and the value the amount charged for it. \n\nA list of possible descriptions are:\n+ Electricity\n+ Water\n+ VAT\n+ GST\n+ Excise Duty\n+ Debt Repayment\n+ Recovery Amount \n\nThe token details section return an array in which each token is specified with its type, token number and units, if applicable. "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"SUCCESS\",\n \"req_session_id\": \"079035ef-8d98-4d59-980b-4c2c4a0a13f4\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"e0fe417f-4c3d-4e93-b08a-fb9676c09fdc\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\"\n },\n \"transaction_detail\": {\n \"tx_date_time\": \"2024-01-04T18:11:05.134+02:00\",\n \"tx_log_id\": 59017182,\n \"tx_status\": \"DELIVERED\"\n },\n \"previous_api_tx_object_id\": \"282\",\n \"next_api_tx_object_id\": \"0\",\n \"next_api_tx_object\": {},\n \"voucher_detail\": {\n \"provider\": {\n \"name\": \"\",\n \"vat_number\": \"C03642301112\"\n },\n \"description\": \"Conlog - Botswana\",\n \"external_reference\": \"20240104181108\",\n \"utility_type\": \"Electricty\",\n \"account_detail\": {\n \"account_holder\": \"Default Test\",\n \"account_number\": \"\"\n },\n \"meter_detail\": {\n \"meter_number\": \"04040404040\",\n \"tt\": \"02\",\n \"krn\": \"1\",\n \"ti\": \"01\",\n \"alg\": \"\",\n \"sgc\": \"990471\"\n }\n },\n \"transaction_value\": {\n \"currency\": \"BWP\",\n \"tendered_value\": \"10000\",\n \"unit_cost\": 8600,\n \"tendered_breakdown\": [\n {\n \"description\": \"Domestic Charges\",\n \"value\": \"0\"\n },\n {\n \"description\": \"Government Levy\",\n \"value\": \"0\"\n },\n {\n \"description\": \"Business Charge\",\n \"value\": \"0\"\n },\n {\n \"description\": \"VAT\",\n \"value\": \"1304\"\n }\n ],\n \"tokens\": [\n {\n \"token_number\": \"74168333273502136940\",\n \"units\": \"130.44\",\n \"token_type\": \"Electricity\"\n }\n ]\n },\n \"instructions\": [\n \"Enter the token numbers into your meter\",\n \"in the order they are displayed.\"\n ],\n \"print_output\": [\n {\n \"key\": \"Trans ID\",\n \"value\": \"59017182\"\n },\n {\n \"key\": \"Provider\",\n \"value\": \"\"\n },\n {\n \"key\": \"VAT number\",\n \"value\": \"C03642301112\"\n },\n {\n \"key\": \"Customer name\",\n \"value\": \"Default Test\"\n },\n {\n \"key\": \"Account\",\n \"value\": \"\"\n },\n {\n \"key\": \"SGC\",\n \"value\": \"990471\"\n },\n {\n \"key\": \"Tariff Index\",\n \"value\": \"01\"\n },\n {\n \"key\": \"Meter number\",\n \"value\": \"04040404040\"\n },\n {\n \"key\": \"Transaction amount\",\n \"value\": \"100\"\n },\n {\n \"key\": \"Units\",\n \"value\": \"130.44\"\n },\n {\n \"key\": \"Domestic Charges\",\n \"value\": \"0\"\n },\n {\n \"key\": \"Government Levy\",\n \"value\": \"0\"\n },\n {\n \"key\": \"Business Charge\",\n \"value\": \"0\"\n },\n {\n \"key\": \"VAT\",\n \"value\": \"13.04\"\n },\n {\n \"key\": \"Electricity\",\n \"value\": \"7416 8333 2735 0213 6940\",\n \"accentuate\": true\n }\n ],\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n }\n}"},{"id":"849fbf50-a384-4229-b64a-53d99b54ccc3","name":"400 Error: Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"37cf306f-a062-498f-9a3c-cae9572894d5\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"615e8509-44e4-46b5-b59d-1808cf0265e1\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 283,\r\n \"parameters\": {\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//prepaid_utility_sale","description":"The meter number and sale value needs to form part of the POST request. Should lookup be a requirement, the lookup's transaction log id should be included as well. \n\nAs the response is generic through different providers and countries, some fields maybe returned emptied depending on the requirements of the Utility provider. \n\nThe provider detail section gives information regarding the Utility Provider which might be legally required to be printed on any slip rendered on behalf of the utility provider.\n\n+ name: The utility provider name\n+ vat_number: The VAT number of the provider\n+ address: The address of the provider\n+ contact_number: The contact number of the provider \n\nIn the account detail section, the information with regards to the account holder who is linked to the meter number is returned. \n\nThe meter detail section provide the details of the specific meter. \n\n+ meter_number: The meter number\n> * The following meter numbers can be used for testing for BPC (Botswana Power Corporation):\n> * For a successful response use: 04040404040\n>\n> * For failed responses use the following\n> * 04040404347 - error message: blocked meter number\n> * 04040404438 - error message: blocked account number\n> * 04040404768 - error message: blocked customer number\n> * 04040406698 - error message: Meter number not found or disconnected meter number\n>\n> * The following meter numbers can be used for testing for LEC (Lesotho Electricity Corporation):\n> * 07091234562\n> * 07000001102\n> * 07000000674\n> * 1234567\n> * 07000000013\n\n+ sgc: Supplier Group Code\n+ krn: Key Revision Number\n+ ti: Tarrif Index\n+ alg: Token Generating Algorithme\n+ tt: Token Technology Code \n\nThe tendered amount are not necessary the value of the utility purchased, this is because the different utility providers may be required by law to recover some additional charges. The tendered breakdown is returned as an array, the description will indicate which charge it is and the value the amount charged for it. \n\nA list of possible descriptions are:\n+ Electricity\n+ Water\n+ VAT\n+ GST\n+ Excise Duty\n+ Debt Repayment\n+ Recovery Amount \n\nThe token details section return an array in which each token is specified with its type, token number and units, if applicable. "},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"f2620013-0319-4e08-875e-5940a8b95449","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"85ecd970-a12c-46a5-a80b-99fbad6ddd4f\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"35e41920-e125-41f7-9c4a-c06509369606\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 283,\r\n \"parameters\": {\r\n \"meter_number\": \"04040404040\",\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//prepaid_utility_sale","description":"The meter number and sale value needs to form part of the POST request. Should lookup be a requirement, the lookup's transaction log id should be included as well. \n\nAs the response is generic through different providers and countries, some fields maybe returned emptied depending on the requirements of the Utility provider. \n\nThe provider detail section gives information regarding the Utility Provider which might be legally required to be printed on any slip rendered on behalf of the utility provider.\n\n+ name: The utility provider name\n+ vat_number: The VAT number of the provider\n+ address: The address of the provider\n+ contact_number: The contact number of the provider \n\nIn the account detail section, the information with regards to the account holder who is linked to the meter number is returned. \n\nThe meter detail section provide the details of the specific meter. \n\n+ meter_number: The meter number\n> * The following meter numbers can be used for testing for BPC (Botswana Power Corporation):\n> * For a successful response use: 04040404040\n>\n> * For failed responses use the following\n> * 04040404347 - error message: blocked meter number\n> * 04040404438 - error message: blocked account number\n> * 04040404768 - error message: blocked customer number\n> * 04040406698 - error message: Meter number not found or disconnected meter number\n>\n> * The following meter numbers can be used for testing for LEC (Lesotho Electricity Corporation):\n> * 07091234562\n> * 07000001102\n> * 07000000674\n> * 1234567\n> * 07000000013\n\n+ sgc: Supplier Group Code\n+ krn: Key Revision Number\n+ ti: Tarrif Index\n+ alg: Token Generating Algorithme\n+ tt: Token Technology Code \n\nThe tendered amount are not necessary the value of the utility purchased, this is because the different utility providers may be required by law to recover some additional charges. The tendered breakdown is returned as an array, the description will indicate which charge it is and the value the amount charged for it. \n\nA list of possible descriptions are:\n+ Electricity\n+ Water\n+ VAT\n+ GST\n+ Excise Duty\n+ Debt Repayment\n+ Recovery Amount \n\nThe token details section return an array in which each token is specified with its type, token number and units, if applicable. "},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"f6a5b046-0b64-4139-9b35-f867dbf23ae7","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"a618a136-9842-4bd9-a167-fe4d0224501e\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"06248bfa-c458-4b39-a803-bd27980f06c7\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 283,\r\n \"parameters\": {\r\n \"meter_number\": \"04040404040\",\r\n \"transaction_value\": 10000\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//prepaid_utility_sale","description":"The meter number and sale value needs to form part of the POST request. Should lookup be a requirement, the lookup's transaction log id should be included as well. \n\nAs the response is generic through different providers and countries, some fields maybe returned emptied depending on the requirements of the Utility provider. \n\nThe provider detail section gives information regarding the Utility Provider which might be legally required to be printed on any slip rendered on behalf of the utility provider.\n\n+ name: The utility provider name\n+ vat_number: The VAT number of the provider\n+ address: The address of the provider\n+ contact_number: The contact number of the provider \n\nIn the account detail section, the information with regards to the account holder who is linked to the meter number is returned. \n\nThe meter detail section provide the details of the specific meter. \n\n+ meter_number: The meter number\n> * The following meter numbers can be used for testing for BPC (Botswana Power Corporation):\n> * For a successful response use: 04040404040\n>\n> * For failed responses use the following\n> * 04040404347 - error message: blocked meter number\n> * 04040404438 - error message: blocked account number\n> * 04040404768 - error message: blocked customer number\n> * 04040406698 - error message: Meter number not found or disconnected meter number\n>\n> * The following meter numbers can be used for testing for LEC (Lesotho Electricity Corporation):\n> * 07091234562\n> * 07000001102\n> * 07000000674\n> * 1234567\n> * 07000000013\n\n+ sgc: Supplier Group Code\n+ krn: Key Revision Number\n+ ti: Tarrif Index\n+ alg: Token Generating Algorithme\n+ tt: Token Technology Code \n\nThe tendered amount are not necessary the value of the utility purchased, this is because the different utility providers may be required by law to recover some additional charges. The tendered breakdown is returned as an array, the description will indicate which charge it is and the value the amount charged for it. \n\nA list of possible descriptions are:\n+ Electricity\n+ Water\n+ VAT\n+ GST\n+ Excise Duty\n+ Debt Repayment\n+ Recovery Amount \n\nThe token details section return an array in which each token is specified with its type, token number and units, if applicable. "},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experienced an error.\"\n }\n}"}],"_postman_id":"b76d6765-aeec-4ecc-b8c6-c8fd49c28e17"},{"name":"bill_lookup","event":[{"listen":"test","script":{"id":"183ad5e3-a3a9-4f28-b74f-e3b5a182a321","exec":[""],"type":"text/javascript"}}],"id":"9f8efed9-ae50-4d06-9b55-c4d9a184f28b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"845c6a68-8f25-45d1-8520-075e2adaf527\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"457c5ba3-3cef-4688-9be3-95b679e59731\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"api_tx_object_id\": 503,\r\n \"parameters\": {\r\n \"account_number\": \"12345678\",\r\n \"transaction_value\": 1000,\r\n \"msisdn\": \"132123123\"\r\n },\r\n \"requester_data\": {\r\n \"requester_field1\": \"123456\",\r\n \"requester_field2\": \"abcd\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"//bill_lookup","description":" This endpoint is intended to be a single endpoint for the vast majority of bill payment transactions where the bill payment process consist our of a two-step process with fist step response returning information about the account, amount owed, payment options available, etc. Because it has to be able to cater for a diverse set up products (electricity bills, pay TV bills, water meter bills, municipal bills, etc), new fields can be added at any time. Therefore, if a field is returned that is not expected by you, you have to ignore it. However, all fields specified in the response schema wil lbe returned with the exception of the following: The response has a generic structure, therefore some fields may return empty as the specific provider might not require the detail to show. amount_due, acceptMultiplesOf, min_vend and max_vend specifies payment limits and rules that apply to the transaction. Example 1. Exact payment of R150.00 required: Example 2. The account has an outstanding balance of R220.00, but any\n amount between R50 and R1000 is allowed as payment. Example 3. Premium-style over-payment allowed in multiples of R100.00,\n for an account with an outstanding balance of R300.00.\n The issuer has a maximum limit of R1500.00 but at least the\n full outstanding amount has to be settled To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information The account number and sale value needs to form part of the POST request. Should lookup be a requirement, the lookup's transaction log id should be included as well. As the response is generic through different providers, countries and bill products, some fields maybe returned emptied depending on the requirements of the service provider. To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information The token details section return an array in which each token is specified with its type, token number and units, if applicable. To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information To see what fields are required for the various bill payment providers, as well as what data will be available in the response, see Additional B2B API information This can require none/any/all of three input parameters, depending on the specific voucher criteria. The transaction can have only one of two responses: Success: A voucher token was generated. Failed: If a voucher token could not be generated, this will be indicated in the structured error message. More information regarding the specific voucher product criteria (variable/fixed amount, pin required, minimum value, maximum value, etc), can be found here:Additional B2B API information Note that some vouchers require that the voucher be protected by a purchaser supplied pin. The PIN has to be at minimum 4 characters in length and not more than 10 characters. It can contain alpha-numeric as well as numeric characters. If the voucher product being redeemed requires a PIN, the PIN must be included in the request Some vouchers also require a msisdn to be supplied at the time of redemption. This is typically used in the case of partial redemptions where the mobile number is then used to send an SMS regarding a new voucher issue for the remainder of the balance, or information regarding the remainder of the balance. The transaction can have only one of two responses: Success: The voucher was redeemed. Failed: The voucher could not be redeemed. There can be multiple reasons why a voucher cannot be redeemed More information regarding the specific voucher product criteria (variable/fixed amount, pin required, minimum value, maximum value, etc), can be found here: Using the confirmation method the integrating party must update the status of the transaction. The updated status is used for recon purposes, and in many cases, for finalisation of the transaction such as for bill payments. The confirmation step is used to confirm whether a transaction has been successfully performed after the fact. The normal process is REQUEST, RECEIVE the token (for example). This confirmation step is one to let Finclude know that you have received the token (TOKEN RECEIVE CONFIRMED) or that you have received payment from you provider. From April 2022, /confirmation calls are compulsory for all vending transactions, especially so for bill payments. The tx_status can be updated to one of the following. Received NotReceived An optional field payment_method can be used to specify the payment method used to perform the transaction. The possible methods are: cash debit credit mobile_wallet voucher store gift combination other The payment method can aid in the recon and reporting processes. Note: If an transaction has not been received the user should perform a transaction_status call to determine the status of the transaction. \n\nThe confirmation step is used to confirm whether a transaction has been successfully performed after the fact. The normal process is REQUEST, RECEIVE the token (for example). This confirmation step is one to let Finclude know that you have received the token (TOKEN RECEIVE CONFIRMED) or that you have received payment from you provider. \n\nFrom April 2022, /confirmation calls are compulsory for all vending transactions, especially so for bill payments. \n\nThe tx_status can be updated to one of the following. \n\n+ Received\n+ NotReceived \n\nAn optional field payment_method can be used to specify the payment method used to perform the transaction. The possible methods are: \n\n+ cash\n+ debit\n+ credit\n+ store\n+ gift\n+ combination\n+ other \n\nThe payment method can aid in the recon and reporting processes. \n\n> **Note:** If an transaction has not been received the user should perform a transaction_status call to determine the status of the transaction."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"SUCCESS\",\n \"req_session_id\": \"7ec445ea-81d7-4035-bf71-a04e97a69d05\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"a64ab0b4-68c7-48b2-8fad-b998e983c2da\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\"\n },\n \"tx_log_id\": 59017188,\n \"updated_fields\": {\n \"tx_status\": \"RECEIVED\",\n \"payment_method\": [\n {\n \"type\": \"credit\",\n \"amount\": 1000\n },\n {\n \"type\": \"cash\",\n \"amount\": 1000\n }\n ]\n }\n}"},{"id":"e141aeb1-341b-4c47-a8a3-b97a4f65783e","name":"400 Error: Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}]","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"2272ab0c-e10a-4f78-ad1d-027dd83e8d3f\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"e1eb1f1a-3b7c-4871-b66f-5c16a8de116f\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n },\n \"update_fields\": {\n \"tx_status\": \"Received\",\n \"payment_method\": [\n {\n \"type\": \"credit\",\n \"amount\": 1000\n },\n {\n \"type\": \"cash\",\n \"amount\": 1000\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"//confirmation","description":"Using the confirmation method the integrating party must update the status of the transaction. The updated status is used for recon purposes, and in many cases, for finalisation of the transaction such as for bill payments. \n\nThe confirmation step is used to confirm whether a transaction has been successfully performed after the fact. The normal process is REQUEST, RECEIVE the token (for example). This confirmation step is one to let Finclude know that you have received the token (TOKEN RECEIVE CONFIRMED) or that you have received payment from you provider. \n\nFrom April 2022, /confirmation calls are compulsory for all vending transactions, especially so for bill payments. \n\nThe tx_status can be updated to one of the following. \n\n+ Received\n+ NotReceived \n\nAn optional field payment_method can be used to specify the payment method used to perform the transaction. The possible methods are: \n\n+ cash\n+ debit\n+ credit\n+ store\n+ gift\n+ combination\n+ other \n\nThe payment method can aid in the recon and reporting processes. \n\n> **Note:** If an transaction has not been received the user should perform a transaction_status call to determine the status of the transaction."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"2a08cf7a-68ff-4bbc-9035-5d13009bc4c0","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}]","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"c1895a0b-f272-4831-b91f-8fcb57b0da5e\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"9d538a3a-69bc-4fde-b5e8-f28ababed2f4\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n },\n \"update_fields\": {\n \"tx_status\": \"Received\",\n \"payment_method\": [\n {\n \"type\": \"credit\",\n \"amount\": 1000\n },\n {\n \"type\": \"cash\",\n \"amount\": 1000\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"//confirmation","description":"Using the confirmation method the integrating party must update the status of the transaction. The updated status is used for recon purposes, and in many cases, for finalisation of the transaction such as for bill payments. \n\nThe confirmation step is used to confirm whether a transaction has been successfully performed after the fact. The normal process is REQUEST, RECEIVE the token (for example). This confirmation step is one to let Finclude know that you have received the token (TOKEN RECEIVE CONFIRMED) or that you have received payment from you provider. \n\nFrom April 2022, /confirmation calls are compulsory for all vending transactions, especially so for bill payments. \n\nThe tx_status can be updated to one of the following. \n\n+ Received\n+ NotReceived \n\nAn optional field payment_method can be used to specify the payment method used to perform the transaction. The possible methods are: \n\n+ cash\n+ debit\n+ credit\n+ store\n+ gift\n+ combination\n+ other \n\nThe payment method can aid in the recon and reporting processes. \n\n> **Note:** If an transaction has not been received the user should perform a transaction_status call to determine the status of the transaction."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"5a0f6a82-cf4a-4f52-ae67-b2b839254d91","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer Transaction detail can be retrieved by using the reprint functionality. The tx_log_id or the org_req_transaction_id of the original transaction is needed for this GET request. The reprint method will return the complete transaction response as it was provided with the original transaction. Note: If requester_data is passed into the reprint request, the same requester_data will be returned in the reprint response. If no requester_data is passed into the request, then the requester data of the original transaction that is being reprinted (if requester data is available), will be returned in the reprint response. Note: The JSON format of the reprint response will depend on the type of the original transaction that is being reprinted. The response for the reprint of a /pin_airtime_data transaction will be different to the response for a /prepaid_utility_sale transaction. To know what the response for a reprint request will look like, you have to look at the response structure of the transaction type that is being reprinted. The cancellation of a transaction can be requested for some transaction objects. The method that will be used to grant a cancellation would depend on the transaction object, provider, timeframe and contracts between the different parties. The following reasons can be used: The reason description is optional and can be used to provide detail towards why the request are done. Different Cancel Types that can be returned in the response Manual \nWhen the response return a manual cancel type it means that the cancellation involves some human intervention and would therefore not happen immediately. It will typically form part of recon process and might even involve some other form of communication between the requester and the Finclude Team. Automatic \nThis type on cancelled transaction are cancelled and the transaction reversed by the system and are therefore completed as indicated by the Cancelled transaction status. Not Allowed \nThis means the transaction cannot be cancelled and therefore no further action will be taken. Note: This method allows for requesting cancellation, requesting does not mean that the cancellation were granted. \n\nThe following reasons can be used: \n\n+ wrongInput: The parameters that were send have incorrect values.\n+ wrongObject: The incorrect transaction object were used.\n+ void: The client has walked out, are unable to pay or some other kind of human error. Void were done by the cashier\n+ autoVoid: The POS system initiated the void, the transaction have been suspended\n+ timeout: The transaction has timed out before the response were received. \n\nThe reason description is optional and can be used to provide detail towards why the request are done. \n\nDifferent Cancel Types that can be returned in the response \n\nManual \nWhen the response return a manual cancel type it means that the cancellation involves some human intervention and would therefore not happen immediately. It will typically form part of recon process and might even involve some other form of communication between the requester and the Finclude Team. \n\nAutomatic \nThis type on cancelled transaction are cancelled and the transaction reversed by the system and are therefore completed as indicated by the Cancelled transaction status. \n\nNot Allowed \nThis means the transaction cannot be cancelled and therefore no further action will be taken. \n\n> **Note:** This method allows for requesting cancellation, requesting does not mean that the cancellation were granted. "},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"SUCCESS\",\n \"req_session_id\": \"c8d77d87-32c2-4e7e-b24c-d5d67b3239f6\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"abb5b629-3a06-4e4c-a660-22c0e2460ca5\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\"\n },\n \"cancelDetail\": {\n \"cancel_req_reason\": \"The client has walked out\",\n \"tx_status\": \"REQUESTCANCEL\",\n \"cancel_type\": \"Manual\",\n \"cancel_message\": \"Manual cancellation takes time, a notification would be send when it is approved\"\n },\n \"requester_data\": {\n \"requester_field1\": \"abcd\",\n \"requester_field2\": \"xyz\"\n }\n}"},{"id":"9f3b7cce-d636-4c26-9afb-9cac7a20f703","name":"400 Error: Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"75420e02-ea7b-4f8a-b774-7daf47bac340\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"79afd6ae-9459-496c-822d-4d0151f8b28a\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n },\n \"cancel_reason_code\": \"void\",\n \"cancel_description\": \"The client has walked out\",\n \"requester_data\": {\n \"requester_field1\": \"abcd\",\n \"requester_field2\": \"xyz\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"//requestCancellation","description":"The cancellation of a transaction can be requested for some transaction objects. The method that will be used to grant a cancellation would depend on the transaction object, provider, timeframe and contracts between the different parties. \n\nThe following reasons can be used: \n\n+ wrongInput: The parameters that were send have incorrect values.\n+ wrongObject: The incorrect transaction object were used.\n+ void: The client has walked out, are unable to pay or some other kind of human error. Void were done by the cashier\n+ autoVoid: The POS system initiated the void, the transaction have been suspended\n+ timeout: The transaction has timed out before the response were received. \n\nThe reason description is optional and can be used to provide detail towards why the request are done. \n\nDifferent Cancel Types that can be returned in the response \n\nManual \nWhen the response return a manual cancel type it means that the cancellation involves some human intervention and would therefore not happen immediately. It will typically form part of recon process and might even involve some other form of communication between the requester and the Finclude Team. \n\nAutomatic \nThis type on cancelled transaction are cancelled and the transaction reversed by the system and are therefore completed as indicated by the Cancelled transaction status. \n\nNot Allowed \nThis means the transaction cannot be cancelled and therefore no further action will be taken. \n\n> **Note:** This method allows for requesting cancellation, requesting does not mean that the cancellation were granted. "},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"871b9e29-e41e-49ce-931c-5a3d5f57d77a","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"3714473e-63ab-44d5-8372-f8506962dc34\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"5e083573-4d5d-4118-91ce-8e3863168bf0\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n },\n \"cancel_reason_code\": \"void\",\n \"cancel_description\": \"The client has walked out\",\n \"requester_data\": {\n \"requester_field1\": \"abcd\",\n \"requester_field2\": \"xyz\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"//requestCancellation","description":"The cancellation of a transaction can be requested for some transaction objects. The method that will be used to grant a cancellation would depend on the transaction object, provider, timeframe and contracts between the different parties. \n\nThe following reasons can be used: \n\n+ wrongInput: The parameters that were send have incorrect values.\n+ wrongObject: The incorrect transaction object were used.\n+ void: The client has walked out, are unable to pay or some other kind of human error. Void were done by the cashier\n+ autoVoid: The POS system initiated the void, the transaction have been suspended\n+ timeout: The transaction has timed out before the response were received. \n\nThe reason description is optional and can be used to provide detail towards why the request are done. \n\nDifferent Cancel Types that can be returned in the response \n\nManual \nWhen the response return a manual cancel type it means that the cancellation involves some human intervention and would therefore not happen immediately. It will typically form part of recon process and might even involve some other form of communication between the requester and the Finclude Team. \n\nAutomatic \nThis type on cancelled transaction are cancelled and the transaction reversed by the system and are therefore completed as indicated by the Cancelled transaction status. \n\nNot Allowed \nThis means the transaction cannot be cancelled and therefore no further action will be taken. \n\n> **Note:** This method allows for requesting cancellation, requesting does not mean that the cancellation were granted. "},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"0f763dd7-f73f-4310-9f0b-849e76c39c65","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"059758a2-8cea-437c-9dd0-02a69cfdc650\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"4e7a539f-8cd2-4d82-9720-585574497bbb\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n },\n \"cancel_reason_code\": \"void\",\n \"cancel_description\": \"The client has walked out\",\n \"requester_data\": {\n \"requester_field1\": \"abcd\",\n \"requester_field2\": \"xyz\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"//requestCancellation","description":"The cancellation of a transaction can be requested for some transaction objects. The method that will be used to grant a cancellation would depend on the transaction object, provider, timeframe and contracts between the different parties. \n\nThe following reasons can be used: \n\n+ wrongInput: The parameters that were send have incorrect values.\n+ wrongObject: The incorrect transaction object were used.\n+ void: The client has walked out, are unable to pay or some other kind of human error. Void were done by the cashier\n+ autoVoid: The POS system initiated the void, the transaction have been suspended\n+ timeout: The transaction has timed out before the response were received. \n\nThe reason description is optional and can be used to provide detail towards why the request are done. \n\nDifferent Cancel Types that can be returned in the response \n\nManual \nWhen the response return a manual cancel type it means that the cancellation involves some human intervention and would therefore not happen immediately. It will typically form part of recon process and might even involve some other form of communication between the requester and the Finclude Team. \n\nAutomatic \nThis type on cancelled transaction are cancelled and the transaction reversed by the system and are therefore completed as indicated by the Cancelled transaction status. \n\nNot Allowed \nThis means the transaction cannot be cancelled and therefore no further action will be taken. \n\n> **Note:** This method allows for requesting cancellation, requesting does not mean that the cancellation were granted. "},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experienced an error.\"\n }\n}"}],"_postman_id":"8fd417cf-df83-4d63-9150-5251363a1433"},{"name":"paygate/geturl","id":"f5d467ee-b254-49bf-86e0-9cdd6ccd76c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"758fad6e-c522-4e8c-8f17-75b1ddb7e22d\",\n \"req_device_id\": \"AB00932\",\n \"req_transaction_id\": \"e8fd7e21-2d4d-4e40-b2e4-2e02b46c118a\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"parameters\": {\n \"api_tx_object_id\": 6,\n \"transaction_value\": 12345,\n \"redirect_URL\": \"https://www.mydomain.com/payment_response_html\",\n \"callback_API_URL\": \"https://www.mydomain.com/payment_response_api\"\n },\n \"requester_data\": {\n \"customer_id\": \"123456\",\n \"account\": \"abcd\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"//paygate/getURL","description":" Whenever calling paygate/payUI, a key needs to be passed in on the URL as a parameter. Calling /paygate/getURL allows you to retrieve that key. Note that the key will change every time /paygate/getURL is called. The key is also time stamped and valid for only a couple of minutes. Request a HTML UI that will present a user with a method to make an alternative form of payment such as a Mobile Wallet payment or redeeming a voucher. If a redirect_URL or a callback_API_URL was specified when the key was retrieved (paygate/getURL), a JSON response will be sent to these when the transaction is completed. \nNote that the format of the JSON will depend on the specific payment product that was used. For example, if the payment type was a Mobile Wallet payment, the JSON response will be as it is described for the /mobile_pay endpoint. \nIf on the other hand, the type of payment was redeeming a voucher, the JSON response will be in the format that is specified for the endpoint that deals with voucher redeeming. (Required) The key received in the response from calling /paygate/getURL.\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n\n
\n
a) The fields starting with \"req_\" in the meta section. Since most of these fields are optional in the request, and their value is simply echoed back in the response, if they are not sent in the request they will not appear in the response.
b) The requester_data section. This section is also optional in the request and is simply echoed back in the response. Therefore, if no requester_data is sent in the request, it will not appear in the response.
\n
\n\n
\n
\n\n
\n
\n\n\n
\n\n**Example 2.** The account has an outstanding balance of R220.00, but any\n\t\t\t amount between R50 and R1000 is allowed as payment.\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 22000 | - | 5000 | 100000 |\n---\n
\n\n**Example 3.** Premium-style over-payment allowed in multiples of R100.00,\n\t\t\t for an account with an outstanding balance of R300.00.\n\t\t\t The issuer has a maximum limit of R1500.00 but at least the\n\t\t\t full outstanding amount has to be settled\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 30000 | 10000 | 30000 | 150000 |\n---\n
\n\n\n
\n\n**Example 2.** The account has an outstanding balance of R220.00, but any\n\t\t\t amount between R50 and R1000 is allowed as payment.\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 22000 | - | 5000 | 100000 |\n---\n
\n\n**Example 3.** Premium-style over-payment allowed in multiples of R100.00,\n\t\t\t for an account with an outstanding balance of R300.00.\n\t\t\t The issuer has a maximum limit of R1500.00 but at least the\n\t\t\t full outstanding amount has to be settled\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 30000 | 10000 | 30000 | 150000 |\n---\n
\n\n\n
\n\n**Example 2.** The account has an outstanding balance of R220.00, but any\n\t\t\t amount between R50 and R1000 is allowed as payment.\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 22000 | - | 5000 | 100000 |\n---\n
\n\n**Example 3.** Premium-style over-payment allowed in multiples of R100.00,\n\t\t\t for an account with an outstanding balance of R300.00.\n\t\t\t The issuer has a maximum limit of R1500.00 but at least the\n\t\t\t full outstanding amount has to be settled\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 30000 | 10000 | 30000 | 150000 |\n---\n
\n\n\n
\n\n**Example 2.** The account has an outstanding balance of R220.00, but any\n\t\t\t amount between R50 and R1000 is allowed as payment.\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 22000 | - | 5000 | 100000 |\n---\n
\n\n**Example 3.** Premium-style over-payment allowed in multiples of R100.00,\n\t\t\t for an account with an outstanding balance of R300.00.\n\t\t\t The issuer has a maximum limit of R1500.00 but at least the\n\t\t\t full outstanding amount has to be settled\n\n| amount_due | acceptMultiplesOf | min_vend | max_vend |\n| -----------|-------------------|-----------|-----------|\n| 30000 | 10000 | 30000 | 150000 |\n---\n
\n\n\n\n
\n\n
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["voucher_redeem"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"96aa8350-5898-47dc-a5fd-7b4d78427eb7","name":"200: Successful payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer \n
\n\n
\n\n
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["confirmation"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"f6235737-fd02-4998-96b9-6f110fcbaf90","name":"200: Confirmation successful","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}]","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"dacad847-3d33-45b0-8eae-0a484e396f95\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"d6672bfd-6048-4520-a7b1-b662192d255b\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n },\n \"update_fields\": {\n \"tx_status\": \"Received\",\n \"payment_method\": [\n {\n \"type\": \"credit\",\n \"amount\": 1000\n },\n {\n \"type\": \"cash\",\n \"amount\": 1000\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west2-development-191509.cloudfunctions.net/babelfish/confirmation","description":"Using the confirmation method the integrating party must update the status of the transaction. The updated status is used for recon purposes, and in many cases, for finalisation of the transaction such as for bill payments.\n
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["reprint"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"aa07c9cd-7cc5-4dfa-a7f6-fea45bdd1539","name":"200: Successful voucher reprint","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"2222b934-8810-43ab-b1ef-0334d98f90b9\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"30549894-e169-43d8-8a3c-fc106e3eac24\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://europe-west2-development-191509.cloudfunctions.net/babelfish/reprint","description":"Transaction detail can be retrieved by using the reprint functionality. The tx_log_id or the org_req_transaction_id of the original transaction is needed for this GET request.\n\nThe reprint method will return the complete transaction response as it was provided with the original transaction.\n\n> **Note:** If requester_data is passed into the reprint request, the same requester_data will be returned in the reprint response. If no requester_data is passed into the request, then the requester data of the original transaction that is being reprinted (if requester data is available), will be returned in the reprint response.\n\n> **Note:** The JSON format of the reprint response will depend on the type of the original transaction that is being reprinted. The response for the reprint of a /pin_airtime_data transaction will be different to the response for a /prepaid_utility_sale transaction. To know what the response for a reprint request will look like, you have to look at the response structure of the transaction type that is being reprinted."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": 0,\n \"response_message\": \"SUCCESS\",\n \"req_session_id\": \"97a5eb22-ba11-4336-8d1a-773e565d2105\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"a83f1f17-6e44-44e0-b922-5d72a92e162e\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\"\n },\n \"transaction_detail\": {\n \"tx_date_time\": \"2024-01-04T18:25:14.591+02:00\",\n \"tx_log_id\": 59017188,\n \"tx_status\": \"DELIVERED\"\n },\n \"voucher_detail\": {\n \"provider\": {\n \"name\": \"Savannacom Water\",\n \"vat_number\": \"\",\n \"address\": \"\",\n \"contact_number\": \"\"\n },\n \"description\": \"Savannacom Water Payment\",\n \"transaction_id\": \"\",\n \"receipt\": \"\",\n \"account_detail\": {\n \"account_holder\": \"\",\n \"account_number\": \"12345678\",\n \"address\": \"\"\n }\n },\n \"transaction_value\": {\n \"currency\": \"ZK\",\n \"tendered_value\": \"1000\",\n \"unit_cost\": 0,\n \"tendered_breakdown\": []\n },\n \"previous_api_tx_object_id\": \"503\",\n \"next_api_tx_object_id\": \"0\",\n \"next_api_tx_object\": {},\n \"data_reference_number\": \"345121\",\n \"requester_data\": {\n \"requester_field1\": \"123456\",\n \"requester_field2\": \"abcd\"\n },\n \"print_output\": [\n {\n \"key\": \"Provider\",\n \"value\": \"Savannacom Water\"\n },\n {\n \"key\": \"Account number\",\n \"value\": \"12345678\"\n },\n {\n \"key\": \"Payment value\",\n \"value\": \"ZK 10\"\n },\n {\n \"key\": \"Reference#\",\n \"value\": \"345121\"\n }\n ]\n}"},{"id":"e44d5fca-00e9-426b-a9f4-af2f2056bae4","name":"400 Error: Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"5b172a95-60ca-4896-82f8-8d7c9f14c3f3\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"0b087d0a-7767-4d40-8638-5c2f7101c4d0\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n }\n}","options":{"raw":{"language":"json"}}},"url":"//reprint","description":"Transaction detail can be retrieved by using the reprint functionality. The tx_log_id or the org_req_transaction_id of the original transaction is needed for this GET request.\n\nThe reprint method will return the complete transaction response as it was provided with the original transaction.\n\n> **Note:** If requester_data is passed into the reprint request, the same requester_data will be returned in the reprint response. If no requester_data is passed into the request, then the requester data of the original transaction that is being reprinted (if requester data is available), will be returned in the reprint response.\n\n> **Note:** The JSON format of the reprint response will depend on the type of the original transaction that is being reprinted. The response for the reprint of a /pin_airtime_data transaction will be different to the response for a /prepaid_utility_sale transaction. To know what the response for a reprint request will look like, you have to look at the response structure of the transaction type that is being reprinted."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"400\",\n \"response_message\": \"Bad Request\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"400008\",\n \"error\": \"invalid_request\",\n \"error_description\": \"Missing parameter value\"\n }\n}"},{"id":"ada2f08e-cc6b-4db2-aaf1-882d91d48df9","name":"401 Error: Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"c43c9d34-6a32-439e-b945-48549c7d33ed\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"e7b66118-c366-4c66-b85c-e1aa1c24e6ba\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"//reprint","description":"Transaction detail can be retrieved by using the reprint functionality. The tx_log_id or the org_req_transaction_id of the original transaction is needed for this GET request.\n\nThe reprint method will return the complete transaction response as it was provided with the original transaction.\n\n> **Note:** If requester_data is passed into the reprint request, the same requester_data will be returned in the reprint response. If no requester_data is passed into the request, then the requester data of the original transaction that is being reprinted (if requester data is available), will be returned in the reprint response.\n\n> **Note:** The JSON format of the reprint response will depend on the type of the original transaction that is being reprinted. The response for the reprint of a /pin_airtime_data transaction will be different to the response for a /prepaid_utility_sale transaction. To know what the response for a reprint request will look like, you have to look at the response structure of the transaction type that is being reprinted."},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"401\",\n \"response_message\": \"Authorization failed\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"401005\",\n \"error\": \"unauthorized_client\",\n \"error_description\": \"Invalid 'authorization token'\"\n }\n}"},{"id":"fc1f509f-f901-496b-86e4-5bc7336e29cd","name":"500 Error: Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"id_token\": \"{{id_token}}\",\n \"req_transaction_id\": \"{{your_unique_transaction_id}}\",\n \"req_session_id\": \"d93cb012-ff0d-4231-9c19-0c8d3b2a97cc\",\n \"req_device_id\": \"AB00932\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"{{org_req_transaction_id}}\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"//reprint","description":"Transaction detail can be retrieved by using the reprint functionality. The tx_log_id or the org_req_transaction_id of the original transaction is needed for this GET request.\n\nThe reprint method will return the complete transaction response as it was provided with the original transaction.\n\n> **Note:** If requester_data is passed into the reprint request, the same requester_data will be returned in the reprint response. If no requester_data is passed into the request, then the requester data of the original transaction that is being reprinted (if requester data is available), will be returned in the reprint response.\n\n> **Note:** The JSON format of the reprint response will depend on the type of the original transaction that is being reprinted. The response for the reprint of a /pin_airtime_data transaction will be different to the response for a /prepaid_utility_sale transaction. To know what the response for a reprint request will look like, you have to look at the response structure of the transaction type that is being reprinted."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"response_code\": \"500\",\n \"response_message\": \"Internal Server Error\",\n \"req_session_id\": \"befab77d-b6df-3974-c987-3b896ec534635\",\n \"req_device_id\": \"E00932\",\n \"req_store_id\": \"store001\",\n \"req_transaction_id\": \"40569911\",\n \"req_date_time\": \"2020-12-10 07:41:30.001\"\n },\n \"error\": {\n \"error_code\": \"500000\",\n \"error\": \"internal_server\",\n \"error_description\": \"The server has experienced an error.\"\n }\n}"}],"_postman_id":"a7b81734-223b-483f-80e8-c7bcc01987e6"},{"name":"requestCancellation","event":[{"listen":"test","script":{"id":"8a0d02f8-bba7-4550-91cf-229f730fb91d","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"0ba8aa2a-2b97-409d-85a8-4de4ad9d4cae","exec":[""],"type":"text/javascript","packages":{}}}],"id":"8fd417cf-df83-4d63-9150-5251363a1433","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"req_session_id\": \"085f0166-4499-4754-8e57-590811bffb31\",\r\n \"req_device_id\": \"AB00932\",\r\n \"req_store_id\": \"21398jsdf98\",\r\n \"req_transaction_id\": \"9e9aacab-aab6-417f-832f-7e0fed034bca\",\r\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\r\n \"req_platform\": \"POS\",\r\n \"original_tx\": {\r\n \"org_req_transaction_id\": \"{{org_req_transaction_id}}\"\r\n },\r\n \"cancel_reason_code\": \"void\",\r\n \"cancel_description\": \"The client has walked out\",\r\n \"requester_data\": {\r\n \"requester_field1\": \"abcd\",\r\n \"requester_field2\": \"xyz\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"//requestCancellation","description":"\n
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access_token}}"}]},"isInherited":true,"source":{"_postman_id":"255ff211-3d7b-424f-852d-48e19328ebdb","id":"255ff211-3d7b-424f-852d-48e19328ebdb","name":"Finclude B2B API","type":"collection"}},"urlObject":{"path":["requestCancellation"],"host":["/"],"query":[],"variable":[]}},"response":[{"id":"e5dd28c3-b65e-4bdb-b23a-1c8fdb7b273a","name":"200: Cancellation request received","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"description":"{{ignore_header}}","key":"x-mock-response-code","value":"200"}],"body":{"mode":"raw","raw":"{\n \"req_session_id\": \"0f0578f9-8e5e-4155-9acf-4521653e414b\",\n \"req_device_id\": \"AB00932\",\n \"req_store_id\": \"21398jsdf98\",\n \"req_transaction_id\": \"ef986d03-28f7-4f21-9d54-5d7558b15130\",\n \"req_date_time\": \"2020-12-10T12:41:00.001+02:00\",\n \"req_platform\": \"POS\",\n \"original_tx\": {\n \"org_req_transaction_id\": \"16484647844\"\n },\n \"cancel_reason_code\": \"void\",\n \"cancel_description\": \"The client has walked out\",\n \"requester_data\": {\n \"requester_field1\": \"abcd\",\n \"requester_field2\": \"xyz\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://europe-west2-development-191509.cloudfunctions.net/babelfish/requestCancellation","description":"The cancellation of a transaction can be requested for some transaction objects. The method that will be used to grant a cancellation would depend on the transaction object, provider, timeframe and contracts between the different parties.