The RAPID PAY COLLECT Mandates API gives developers the opportunity to manage Debicheck Mandates and Collections using their own software solutions. The Mandates API functions differently to the original RAPID PAY COLLECT API in that it makes use of a RESTful service as opposed to the XML form post structure of the original API.
\nContact RAPID PAY COLLECT and request access to Mandates for a specific user account. Alternatively, RAPID PAY COLLECT can setup a new user account specifically for the purposes of accessing the Mandates API. Please note that the username and password this account uses to access the API can also be used to access the secure online portal.
\nThe RAPID PAY COLLECT Mandates API makes use of Token Based Authentication, meaning that a preliminary call needs to be made to the /token endpoint in order to generate a bearer token, which will be used in authenticating all subsequent API Calls.
\nThe baseUrl variable value for all TEST API calls is;
\n\nThe baseUrl variable value for all LIVE API calls is;
\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"About","slug":"about"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"API Url","slug":"api-url"}],"owner":"6864947","collectionId":"bc297ff2-e3db-4da9-9f5e-3eeedfd3a781","publishedId":"TzRPj9NX","public":true,"customColor":{"top-bar":"000","right-sidebar":"f8f8f8","highlight":"EC1C24"},"publishDate":"2021-05-06T17:44:07.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"9f95173d-ee90-4b7e-be9f-66b40fbc4488","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"accessToken\", data.access_token);","pm.variables.get(\"accessToken\");"],"type":"text/javascript"}}],"id":"b4a73cbf-45fd-4b50-940e-87c8f797016f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"userName","value":"","type":"text"},{"key":"password","value":"","type":"text"}]},"url":"https://api.rapidpaycollect.co.za/token","description":"Is used for generating an access token. This access token is used as a bearer token when authenticating subsequent API requests.
\nThe {{username}} and passed in the body of your authentication request are the username and password assigned to you by RapidCollect.
\n","urlObject":{"path":["token"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"9253c184-777b-42ba-8b7f-70785d41a37c","name":"400 Bad Request - Unsuccessful Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"userName","value":"","type":"text"},{"key":"password","value":"","type":"text"}]},"url":"https://api.rapidpaycollect.co.za/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"87"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":""},{"key":"X-StackifyID","value":"V2|bd627c18-a94b-4046-a61d-9506fce4c2b9|C61560|CD1"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Powered-By","value":""},{"key":"Date","value":"Fri, 24 May 2019 08:42:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"invalid_grant\",\n \"error_description\": \"The user name or password is incorrect.\"\n}"},{"id":"e5561895-2c33-48b9-a6fd-0b8d48031c55","name":"200 OK - Successful Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"userName","value":"YourUserName","type":"text"},{"key":"password","value":"YourPassword","type":"text"}]},"url":"https://api.rapidpaycollect.co.za/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXHRva2Vu?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 08:28:03 GMT"},{"key":"Content-Length","value":"487"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"-zUCyPYZ3UluMqB2GTSBfzG4Vtxz7Zddo9ZyF-7On1TUijtKxGXDfPFuKN_3jWglC2xNxx_KD57jXr6jLiK7bXF1J6v0kGQbiTm0jxbF8jL38i73uFIyLRJLdXFTiN_ZTdBZx71cygRwELr9UD3bIIwaoRjnGUK8tktxWaDc-bqC0E-Kwxrikh5DHegeXCxmJrUAL9PuxfIT719rpE4CmjNgvltg5yrdzTJrrzFGTkNu57ERvSBfbIJFMoJruacL9fm55YI1KxsNUqZ7GASmH_I9AnactA7qOgx7oFgoMtTv-TLpCGxmdLiZSBRoN8LA_hy4K8ygOz_eLwBESyw3r7UUIwx7BeaOWZEqhRTvCldl7ONaRBZJrBhtfUj8qO3vt14IsF43DVdl8ios1ElbSE7-Yg-16thjYyoW1kFt5lE\",\n \"token_type\": \"bearer\",\n \"expires_in\": 86399\n}"}],"_postman_id":"b4a73cbf-45fd-4b50-940e-87c8f797016f"}],"id":"0e99b599-979b-4841-b5ee-0e416f934e32","description":"The API makes use of a bearer token in order to authenticate all requests to the API. In order to obtain a token, submit a POST (x-www-form-urlencoded) request to the '/token' authentication end point.
\n","event":[{"listen":"prerequest","script":{"id":"5d423bee-3651-4132-a3e2-c1ff9f1a47c2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"240f4dd6-a215-44f6-87f1-62e4f1c68845","type":"text/javascript","exec":[""]}}],"_postman_id":"0e99b599-979b-4841-b5ee-0e416f934e32"},{"name":"Get Mandate Lookup Types","item":[{"name":"Get Initiation Transaction Types","id":"d7d20d66-2f4f-4806-8a3a-ac57f1769be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.rapidpaycollect.co.za/mandates/initiation-transaction-types","description":"Returns a list of possible Transaction Types, which can be used when performing an initiation. Transaction Types, refer to the method with which the debtor will authenticate the mandate.
\nReturns a list of possible Transaction Types, which can be used when performing an amendment. Transaction Types, refer to the method with which the debtor will authenticate the mandate.
\nReturns a list of potential collection occurence types.
\nReturns a list of potential amendment reasons, which can be assigned when amending a mandate.
\nReturns a list of available collection days, which can be assigned when posting a mandate initiation or amendment.
\nReturns a list of possible adjustment categories for making collection amount adjustments on mandates.
\nReturns a list of available bank account types, which can be assigned when generating a mandate.
\nReturns a list of collection entry classes which can be assigned to a mandate.
\nReturns a list of cancellation reasons which need to be assigned when submitting a mandate cancellation.
\nReturns a list of possible mandate statuses.
\nReturns a list of debit value types.
\nReturns a list of collection frequency options which can be assigned to a mandate.
\nThe Mandates API, makes use of multiple lookup types for defining mandate related type values.
\nThe API call for each of these types will return all available values along with their associated IDs. These Ids can then be assigned to their associated fields when performing subsequent API calls.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This method is used for searching mandates which have already been submitted. Result sets are restricted to user/client access permissions.
\n","urlObject":{"path":["mandates"],"host":["https://api.rapidpaycollect.co.za"],"query":[{"description":{"content":"A comma separated list of client codes. Should you have access to more than one client, and you want to restrict the result set to specifiic clients, you can indicate which clients' mandates you want returned here.
\n","type":"text/plain"},"key":"clients","value":null},{"description":{"content":"A comma seperated list of mandate status Ids
\n","type":"text/plain"},"key":"statuses","value":""},{"description":{"content":"A comma seperated list of debit value type Ids
\n","type":"text/plain"},"key":"types","value":""},{"description":{"content":"A comma seperated list of collection frequency Ids
\n","type":"text/plain"},"key":"collectionFrequencies","value":""},{"description":{"content":"The debtor Id number
\n","type":"text/plain"},"key":"debtorIdNumber","value":""},{"description":{"content":"The debtor bank account number
\n","type":"text/plain"},"key":"debtorAccountNumber","value":""},{"description":{"content":"The start date of the period in which mandates being searched for were created
\n","type":"text/plain"},"key":"createdStartDate","value":null},{"description":{"content":"The end date of the period in which mandates being searched for were created
\n","type":"text/plain"},"key":"createdEndDate","value":null},{"description":{"content":"The debtor's first, last or full name
\n","type":"text/plain"},"key":"debtorName","value":null},{"description":{"content":"The mandate bank reference number of a specific mandate.
\n","type":"text/plain"},"key":"mandateReferenceNumber","value":null}],"variable":[]}},"response":[{"id":"d968f11e-5791-47f9-82a3-c107d24febed","name":"200 OK - Successful Search Mandates","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":{"raw":"https://api.rapidpaycollect.co.za/mandates?clients={{clientCode}}&statuses=1&types=2&collectionFrequencies=1&debtorIdNumber=&debtorAccountNumber=&createdStartDate=&createdEndDate=","host":["https://api.rapidpaycollect.co.za"],"path":["mandates"],"query":[{"key":"clients","value":"{{clientCode}}"},{"key":"statuses","value":"1"},{"key":"types","value":"2"},{"key":"collectionFrequencies","value":"1"},{"key":"debtorIdNumber","value":""},{"key":"debtorAccountNumber","value":""},{"key":"createdStartDate","value":""},{"key":"createdEndDate","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVz?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 10:24:05 GMT"},{"key":"Content-Length","value":"122846"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"mandateId\": \"050199071147170092233010084253052176214232190081\",\n \"mandateReference\": \"\",\n \"customerCode\": \"TEST456\",\n \"contractReference\": \"MandateTest2\",\n \"authenticationDate\": null,\n \"initiationDate\": \"2019-05-23T13:00:20.617\",\n \"creationDate\": \"2019-05-23T13:00:20.617\",\n \"releaseDate\": null,\n \"entryClass\": \"Value Added Tax\",\n \"entryClassId\": 12,\n \"status\": \"Pending authentication\",\n \"statusId\": 2,\n \"type\": \"Fixed\",\n \"typeId\": 1,\n \"transactionType\": \"TT1 - real-time - without cellphone authentication\",\n \"transactionTypeId\": 2,\n \"cancellationReason\": null,\n \"clientName\": \"Test Client\",\n \"replacedMandateId\": null,\n \"amended\": false,\n \"debtor\": {\n \"name\": \"Joe Soap\",\n \"accountNumber\": \"62421525489\",\n \"branchCode\": \"250655\",\n \"accountType\": null,\n \"accountTypeId\": 0,\n \"emailAddress\": null,\n \"contactNumberInternationalCode\": null,\n \"contactNumber\": null,\n \"identificationNumber\": null,\n \"passportNumber\": null\n }\n },\n {\n \"mandateId\": \"189084118181229192100066058070117065222177030069\",\n \"mandateReference\": \"12341234132413412421\",\n \"customerCode\": \"TEST123\",\n \"contractReference\": \"123Insurance\",\n \"authenticationDate\": null,\n \"initiationDate\": \"2019-05-23T12:45:51.317\",\n \"creationDate\": \"2019-05-23T12:45:51.317\",\n \"releaseDate\": null,\n \"entryClass\": \"Insurance Premium\",\n \"entryClassId\": 1,\n \"status\": \"Accepted\",\n \"statusId\": 3,\n \"type\": \"Variable\",\n \"typeId\": 2,\n \"transactionType\": \"TT1 - real-time - with cellphone authentication\",\n \"transactionTypeId\": 1,\n \"cancellationReason\": null,\n \"clientName\": \"Test Client\",\n \"replacedMandateId\": null,\n \"amended\": false,\n \"debtor\": {\n \"name\": \"Joe Bloggs\",\n \"accountNumber\": \"62421256487\",\n \"branchCode\": \"250655\",\n \"accountType\": null,\n \"accountTypeId\": 0,\n \"emailAddress\": null,\n \"contactNumberInternationalCode\": null,\n \"contactNumber\": null,\n \"identificationNumber\": null,\n \"passportNumber\": null\n }\n }\n ],\n \"pageData\": {\n \"pageCount\": 1,\n \"pageNumber\": 0,\n \"pageSize\": 20,\n \"totalResults\": 2,\n \"showPreviousPage\": false,\n \"showNextPage\": false,\n \"previousPageNumber\": null,\n \"nextPageNumber\": null,\n \"pages\": [\n {\n \"pageNumber\": \"1\",\n \"cssClass\": \"\",\n \"pageUrl\": null\n }\n ]\n }\n}"}],"_postman_id":"608908b0-01c1-4720-822d-fc096f186f92"},{"name":"Get Mandate","event":[{"listen":"test","script":{"id":"c1ec97ce-60a4-47fd-9a12-0c5ca45de967","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateReference\", data.mandateReference);","pm.variables.get(\"mandateReference\");",""],"type":"text/javascript"}}],"id":"405173b7-e4a1-48dc-b52f-64f153f58c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.rapidpaycollect.co.za/mandates/{{mandateId}}","description":"This method allows integrators to fetch a single mandate using the mandate ID supplied in the search mandates request.
\n","urlObject":{"path":["mandates","{{mandateId}}"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"d46b1141-6ac1-4445-b113-aa49f686b9a6","name":"200 OK - Successful Get Mandate","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.rapidpaycollect.co.za/mandates/{{mandateId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXDIyNjA2NzA0MTI0MjE1NDE1NTEyMjE0MjE5MjA4NjI0NzAxMzA2NTA1NTE4NjA5Ng==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 10:29:47 GMT"},{"key":"Content-Length","value":"1312"}],"cookie":[],"responseTime":null,"body":"{\n \"mandateId\": \"226067041242154155122142192086247013065055186096\",\n \"mandateReference\": \"100000000378\",\n \"customerCode\": \"SWM123\",\n \"contractReference\": \"SWM123\",\n \"authorisationDate\": null,\n \"initiationDate\": null,\n \"creationDate\": \"2019-04-12T11:35:56.78\",\n \"releaseDate\": null,\n \"entryClass\": \"Bond Repayment\",\n \"entryClassId\": 14,\n \"status\": \"Pending authentication\",\n \"statusId\": 2,\n \"replacedMandateId\": null,\n \"amended\": true,\n \"cancelled\": true,\n \"canBeDeleted\": false,\n \"canBeAmendedOrCancelled\": false,\n \"type\": \"Fixed\",\n \"typeId\": 1,\n \"transactionType\": \"Unknown\",\n \"transactionTypeId\": 0,\n \"cancellationReason\": null,\n \"debtor\": {\n \"name\": \"Joe Soap\",\n \"accountNumber\": \"12345678951\",\n \"branchCode\": \"250655\",\n \"accountType\": \"CurrentCheque\",\n \"accountTypeId\": 1,\n \"emailAddress\": \"joeemails@1234.co.za\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"841234567\",\n \"identificationNumber\": \"7502125054678\",\n \"passportNumber\": null\n },\n \"collection\": {\n \"occurrence\": \"OnceOff\",\n \"occurrenceId\": 1,\n \"collectionAmount\": 0.15,\n \"maximumCollectionAmount\": 0.15,\n \"firstCollectionAmount\": null,\n \"adjustmentRate\": null,\n \"frequency\": \"Monthly\",\n \"frequencyId\": 3,\n \"trackingAllowed\": true,\n \"dateAdjustmentAllowed\": false,\n \"collectionDay\": 27,\n \"adjustmentCategory\": \"Never\",\n \"adjustmentCategoryId\": 1,\n \"adjustmentAmount\": null\n },\n \"client\": {\n \"clientCode\": \"PSZer001\",\n \"name\": \"Zero Zero One\"\n },\n \"batch\": {\n \"batchNumber\": \"32\",\n \"description\": \"\"\n }\n}"}],"_postman_id":"405173b7-e4a1-48dc-b52f-64f153f58c89"},{"name":"Get Mandate History","id":"4b93fec5-8412-4978-80b6-5b4ed8c19277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.rapidpaycollect.co.za/mandates/history/{{mandateId}}","description":"This method allows integrators to return the change history related to a mandate.
\n","urlObject":{"path":["mandates","history","{{mandateId}}"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"fe4544a4-4306-4c78-9db7-d9c222e4cd9e","name":"200 OK - Successful Get Mandate History","originalRequest":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"url":"https://api.rapidpaycollect.co.za/mandates/history/{{mandateId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGhpc3RvcnlcMTAzMTUzMTU4MDQ3MjI2MjQzMTQyMjQyMDE2MjE1MDU4MTc4MDI5MDM4MjE4MTUx?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 29 May 2019 07:39:18 GMT"},{"key":"Content-Length","value":"1115"}],"cookie":[],"responseTime":null,"body":"{\n \"results\": [\n {\n \"mandateId\": \"103153158047226243142242016215058178029038218151\",\n \"timestamp\": \"2019-05-28T15:26:49.153\",\n \"message\": \"Mandate Cancellation Saved\",\n \"replacementMandateId\": \"211049116222107000163017184042037222192021169110\",\n \"hasAmendment\": false\n },\n {\n \"mandateId\": \"103153158047226243142242016215058178029038218151\",\n \"timestamp\": \"2019-05-28T15:25:17.947\",\n \"message\": \"Mandate Amended\",\n \"replacementMandateId\": \"104024131053121104083002187014219131032126172146\",\n \"hasAmendment\": true\n },\n {\n \"mandateId\": \"103153158047226243142242016215058178029038218151\",\n \"timestamp\": \"2019-05-28T15:24:36.82\",\n \"message\": \"Mandate Pending authentication\",\n \"replacementMandateId\": \"211049116222107000163017184042037222192021169110\",\n \"hasAmendment\": false\n },\n {\n \"mandateId\": \"103153158047226243142242016215058178029038218151\",\n \"timestamp\": \"2019-05-28T15:24:36.8\",\n \"message\": \"Mandate Saved\",\n \"replacementMandateId\": \"211049116222107000163017184042037222192021169110\",\n \"hasAmendment\": false\n }\n ],\n \"pageData\": {\n \"pageCount\": 1,\n \"pageNumber\": 1,\n \"pageSize\": 20,\n \"totalResults\": 4,\n \"showPreviousPage\": false,\n \"showNextPage\": false,\n \"previousPageNumber\": null,\n \"nextPageNumber\": null,\n \"pages\": []\n }\n}"}],"_postman_id":"4b93fec5-8412-4978-80b6-5b4ed8c19277"}],"id":"0a085df3-3d31-4ed6-a6f7-ae80eb2c19c1","_postman_id":"0a085df3-3d31-4ed6-a6f7-ae80eb2c19c1","description":""},{"name":"Save/Update/Delete Mandates","item":[{"name":"Initiate Mandate","event":[{"listen":"test","script":{"id":"67091dbc-589d-4a0c-8631-00c9d7fb180f","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}}],"id":"499f7e4d-04e9-40cc-bde5-730f9177a88e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"10\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"0.10\",\n \"maximumCollectionAmount\": \"0.10\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/initiate","description":"This method is used for initiating a new mandate.
\n","urlObject":{"path":["mandates","initiate"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"671950a7-9666-485f-96c0-3cf141db28fd","name":"400 Bad Request - Unsuccessful (CDV Error) Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"debtor.accountNumber\": [\n \"Account number is not valid for First National Bank\"\n ]\n }\n}"},{"id":"8b669b2d-654a-4544-b706-5daa1d3fe111","name":"200 OK - Successful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGluaXRpYXRl?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 10:32:24 GMT"},{"key":"Content-Length","value":"209"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"b6b87e1c-0ea9-4df9-b1e8-257c1beccd55\",\n \"mandateReference\": \"\",\n \"mandateId\": \"004151246032017019205100005030159132020000186049\",\n \"statusId\": 10,\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"errors\": []\n}"},{"id":"ced2c23c-cd19-44ef-801d-776d317325ab","name":"400 Bad Request - Unsuccessful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"contractReference\": [\n \"Contract Reference cannot be longer than 14 characters\"\n ]\n }\n}"}],"_postman_id":"499f7e4d-04e9-40cc-bde5-730f9177a88e"},{"name":"Amend Mandate","event":[{"listen":"test","script":{"id":"6cc12338-5892-4b5f-93fd-395da19c1c96","exec":[""],"type":"text/javascript"}}],"id":"4fda05bf-82fb-4787-8860-a43617d0f674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend","description":"This method is used for submitting a mandate amendment. Most mandate changes will need to be reauthenticated by the debtor in question.
\nShould the mandate being sent through for amendment already have an amendment pending, you will receve an Internal Server Error in response.
\n","urlObject":{"path":["mandates","amend"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"c1559cca-ee7d-4e72-bdf7-5c6d26ca77e1","name":"200 OK - Successful Amend Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGFtZW5k?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 12:44:32 GMT"},{"key":"Content-Length","value":"216"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"a3e559ef-4f73-4f8d-bc8d-442cdff98a06\",\n \"mandateId\": \"077213007242040028031170032023241142168202000105\",\n \"mandateReference\": \"\",\n \"statusId\": 30,\n \"status\": \"DebtorNotified\",\n \"message\": \"Success\",\n \"errors\": []\n}"},{"id":"f0b379d0-9711-4db5-86c8-99573d2daeab","name":"500 Internal Server Error - Unsuccessful Amend Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"callbackUrl\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGFtZW5k?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 13:20:57 GMT"},{"key":"Content-Length","value":"618"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"An error has occurred.\",\n \"exceptionMessage\": \"Mandate already has amendment pending.\",\n \"exceptionType\": \"System.InvalidOperationException\",\n \"stackTrace\": \" at PaySoft.Api.Core.Services.MandateService.AmendMandate(AmendMandateModel mandate) in C:\\\\Work\\\\Projects\\\\Paysoft Front Office\\\\Code\\\\Paysoft\\\\Secure\\\\PaySoft.Api.Core\\\\Services\\\\MandateService.cs:line 480\\r\\n at PaySoft.Api.Core.Controllers.Public.MandatesController.Amend(MandateAmendRequestViewModel mandate) in C:\\\\Work\\\\Projects\\\\Paysoft Front Office\\\\Code\\\\Paysoft\\\\Secure\\\\PaySoft.Api.Core\\\\Controllers\\\\Public\\\\MandatesController.cs:line 308\"\n}"}],"_postman_id":"4fda05bf-82fb-4787-8860-a43617d0f674"},{"name":"Cancel Mandate","id":"983f6e23-41e8-4131-be90-4208e9cc3b48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{mandateId}}\",\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates/cancel","description":"This method is used for cancelling a mandate. Make certain to include a cancellation reason when submitting a mandate cancellation.
\n","urlObject":{"path":["mandates","cancel"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"1fde6532-adb9-418e-83c3-c1041069a508","name":"200 OK - Successful Cancel Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{mandateId}}\",\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGNhbmNlbA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 12:47:59 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"983f6e23-41e8-4131-be90-4208e9cc3b48"},{"name":"Import Mandates Batch","id":"daa5bb2e-0bde-410f-afd8-9f07281a9486","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"mandates\": [\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST12\",\n \"contractReference\": \"Payment\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"6/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Bloggs\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0721234657\",\n \"debtorEmailAddress\": \"test@test.co.za\",\n \"debtorAccountNumber\": \"98765432145\",\n \"debtorBranchCode\": \"198765\",\n \"debtorAccountType\": \"2\",\n \"isMigratedNaedo\": 0\n },\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST123\",\n \"contractReference\": \"Insurance\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"6/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Soap\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0841234567\",\n \"debtorEmailAddress\": \"test@test\",\n \"debtorAccountNumber\": \"1234567894\",\n \"debtorBranchCode\": \"198765\",\n \"debtorAccountType\": \"1\",\n \"isMigratedNaedo\": 0\n }\n ]\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/import","description":"Allows integrators to import a batch of mutliple mandates.
\n","urlObject":{"path":["mandates","import"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"711bd046-5dad-4d82-8825-52b20e004232","name":"200 OK - With Errors Import Mandates Batch","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"mandates\": [\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST12\",\n \"contractReference\": \"Payment\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"4/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Bloggs\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0721234657\",\n \"debtorEmailAddress\": \"test@test.co.za\",\n \"debtorAccountNumber\": \"98765432145\",\n \"debtorBranchCode\": \"198765\",\n \"debtorAccountType\": \"2\"\n },\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST123\",\n \"contractReference\": \"Insurance\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"4/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Soap\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0841234567\",\n \"debtorEmailAddress\": \"test@test\",\n \"debtorAccountNumber\": \"1234567894\",\n \"debtorBranchCode\": \"198765\",\n \"debtorAccountType\": \"1\"\n },\n\n ]\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGltcG9ydA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 13:21:53 GMT"},{"key":"Content-Length","value":"423"}],"cookie":[],"responseTime":null,"body":"{\n \"mandateBatchId\": null,\n \"isSuccessful\": false,\n \"message\": \"Failed to upload, one or more of the mandates failed validation. Please fix all errors before trying again.\",\n \"errors\": [\n {\n \"rowNumber\": 1,\n \"errorMessage\": \"A future dated release date is required, Account number is not valid for Nedbank Corporate Saver\"\n },\n {\n \"rowNumber\": 2,\n \"errorMessage\": \"A future dated release date is required, CDV test failed, Email address is not valid\"\n }\n ]\n}"},{"id":"2f88d833-742a-4804-8a67-441e8a6386f1","name":"200 OK - Successful Import Mandates Batch","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"mandates\": [\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST12\",\n \"contractReference\": \"Payment\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"6/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Bloggs\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0721234657\",\n \"debtorEmailAddress\": \"test@test.co.za\",\n \"debtorAccountNumber\": \"6242121345\",\n \"debtorBranchCode\": \"250655\",\n \"debtorAccountType\": \"1\"\n },\n {\n \"status\": \"1\",\n \"customerCode\": \"PSTEST123\",\n \"contractReference\": \"Insurance\",\n \"type\": \"1\",\n \"entryClass\": \"14\",\n \"releaseDate\": \"6/29/19\",\n \"collectionDay\": \"30\",\n \"collectionFrequency\": \"3\",\n \"collectionInstalmentAmount\": \"0.15\",\n \"collectionInstalmentOccurrence\": \"1\",\n \"collectionMaxAmount\": \"0.15\",\n \"collectionAdjustmentCategory\": \"1\",\n \"collectionCanTrack\": \"1\",\n \"debtorName\": \"Joe Soap\",\n \"debtorIdNumber\": \"4712245149011\",\n \"debtorContactNumberInternationalCode\": \"+27\",\n \"debtorContactNumber\": \"0841234567\",\n \"debtorEmailAddress\": \"test@test.com\",\n \"debtorAccountNumber\": \"6242121345\",\n \"debtorBranchCode\": \"250655\",\n \"debtorAccountType\": \"1\"\n },\n\n ]\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/import"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGltcG9ydA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 29 May 2019 07:44:54 GMT"},{"key":"Content-Length","value":"73"}],"cookie":[],"responseTime":null,"body":"{\n \"mandateBatchId\": 72,\n \"isSuccessful\": true,\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"daa5bb2e-0bde-410f-afd8-9f07281a9486"},{"name":"Delete Mandate","id":"222a90f8-4647-42e3-b973-90ed3990f787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{mandateId}}\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates","description":"This method is used for deleting a mandate. Only mandates which have not been accepted can be deleted. If integrators wsh to remove an accepted mandate, a cancellation request needs to be performed instead.
\n","urlObject":{"path":["mandates"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"c1a48b6b-84c4-4394-885f-f1e89cde358c","name":"400 Bad Request - Unsuccessful Delete Mandate","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{mandateId}}\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bank initiated mandates cannot be deleted\"\n}"},{"id":"b8892ac7-85df-4b6b-b1d7-e1ca65c71537","name":"200 OK - Successful Delete Mandate","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":\"{{mandateId}}\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVz?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 12:50:19 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"222a90f8-4647-42e3-b973-90ed3990f787"},{"name":"Resubmit As Registered Mandates","id":"699abc21-8571-4556-bab9-d7fa99fe1ef2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"mandateId\": [\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rapidpaycollect.co.za/mandates/resubmit-rms","urlObject":{"path":["mandates","resubmit-rms"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"2fc54697-a715-4db9-8a93-32a262f51ff6","name":"Resubmit As Registered Mandates","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{accessToken}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"mandateId\": [\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\",\r\n \"{{mandateId}}\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rapidpaycollect.co.za/mandates/resubmit-rms"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlTb2Z0XGhvdC1maXhlc1xTZWN1cmVcUGF5U29mdC5BcGlcbWFuZGF0ZXNccmVzdWJtaXQtcm1z?="},{"key":"Date","value":"Mon, 10 May 2021 09:17:16 GMT"},{"key":"Content-Length","value":"904"}],"cookie":[],"responseTime":null,"body":"\"Mandate(s) successfully resubmitted as registered mandate(s).\""}],"_postman_id":"699abc21-8571-4556-bab9-d7fa99fe1ef2"}],"id":"cf5bd41c-3fd4-4820-a1d6-d91af1fb2398","event":[{"listen":"prerequest","script":{"id":"7a3f2f76-768f-4132-b035-d76bc809d483","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"08c766f7-87f7-46ae-9cdf-34fb47103b6d","type":"text/javascript","exec":[""]}}],"_postman_id":"cf5bd41c-3fd4-4820-a1d6-d91af1fb2398","description":""},{"name":"Save/Update Mandate Test Cases","item":[{"name":"Initiate Mandate - Accepted","event":[{"listen":"test","script":{"id":"67091dbc-589d-4a0c-8631-00c9d7fb180f","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}}],"id":"122b4968-fe71-40ba-af52-ce7161480a5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/initiate","description":"In order to simulate Debtor responses for initiated mandates, all mandates using an entry class of 1 (Insurance Premium), will be accepted by the Debtor, all others will be rejected.
\n","urlObject":{"path":["mandates","initiate"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"0ecaff48-0418-467b-a54c-d68965fbe78e","name":"200 OK - Successful Initiate Mandate - Will be accepted by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGluaXRpYXRl?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 10:32:24 GMT"},{"key":"Content-Length","value":"209"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"b6b87e1c-0ea9-4df9-b1e8-257c1beccd55\",\n \"mandateReference\": \"\",\n \"mandateId\": \"004151246032017019205100005030159132020000186049\",\n \"statusId\": 10,\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"122b4968-fe71-40ba-af52-ce7161480a5c"},{"name":"Initiate Mandate - Rejected","event":[{"listen":"test","script":{"id":"67091dbc-589d-4a0c-8631-00c9d7fb180f","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}}],"id":"0d3ac02c-e1d2-4b28-b67e-faba7c402de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/initiate","description":"In order to simulate Debtor responses for initiatied mandates, all mandates using an entry class of 1 (Insurance Premium), will be accepted by the Debtor, all others will be rejected.
\n","urlObject":{"path":["mandates","initiate"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"9e9ee285-c824-4148-aa4d-d95a42f59d04","name":"200 OK - Successful Initiate Mandate - Will be rejected by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGluaXRpYXRl?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 24 May 2019 10:32:24 GMT"},{"key":"Content-Length","value":"209"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"b6b87e1c-0ea9-4df9-b1e8-257c1beccd55\",\n \"mandateReference\": \"\",\n \"mandateId\": \"004151246032017019205100005030159132020000186049\",\n \"statusId\": 10,\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"0d3ac02c-e1d2-4b28-b67e-faba7c402de5"},{"name":"Amend Mandate - Accepted","event":[{"listen":"test","script":{"id":"6cc12338-5892-4b5f-93fd-395da19c1c96","exec":[""],"type":"text/javascript"}}],"id":"b3ca4d06-6cf0-4392-9807-c5d1804f1508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend","description":"In order to simulate Debtor responses for amended mandates, all mandates using an amendment reason code of 1 (Request by Customer), will be accepted by the Debtor, all others will be rejected.
\n","urlObject":{"path":["mandates","amend"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"034cdb1e-a21d-4794-9d6f-d1917272c8f5","name":"200 OK - Successful Amend Mandate - Will be accepted by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGFtZW5k?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 13:24:09 GMT"},{"key":"Content-Length","value":"216"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"df993d40-7b9f-44dc-84cc-f546d992add4\",\n \"mandateId\": \"182031044238162175253046225136065170148165182167\",\n \"mandateReference\": \"\",\n \"statusId\": 30,\n \"status\": \"DebtorNotified\",\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"b3ca4d06-6cf0-4392-9807-c5d1804f1508"},{"name":"Amend Mandate - Rejected","event":[{"listen":"test","script":{"id":"6cc12338-5892-4b5f-93fd-395da19c1c96","exec":[""],"type":"text/javascript"}}],"id":"9428349e-b3ae-4a96-9013-5119c8ed9eb7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"2\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend","description":"In order to simulate Debtor responses for amended mandates, all mandates using an amendment reason code of 1 (Request by Customer), will be accepted by the Debtor, all others will be rejected.
\n","urlObject":{"path":["mandates","amend"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"87e3e6a1-3278-4754-8246-ded109192f96","name":"200 OK - Successful Amend Mandate - Will be rejected by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{token}}","warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman."}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"{{clientCode}}\",\n \"mandateReference\": \"{{mandateReference}}\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"2\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"collectionDay\": \"1\",\n \"collectionAmount\": \"0.16\",\n \"maximumCollectionAmount\": \"0.16\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"1\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/amend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGFtZW5k?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 13:25:21 GMT"},{"key":"Content-Length","value":"216"}],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"f8096e57-6c82-479f-9cf9-04f3605dc307\",\n \"mandateId\": \"104024131053121104083002187014219131032126172146\",\n \"mandateReference\": \"\",\n \"statusId\": 30,\n \"status\": \"DebtorNotified\",\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"9428349e-b3ae-4a96-9013-5119c8ed9eb7"},{"name":"Cancel Mandate - Successful","id":"28dd80ba-a022-4567-90aa-e57e682d73d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\":{{mandateId}},\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates/cancel","description":"All cancelled mandates will be marked as cancelled
\n","urlObject":{"path":["mandates","cancel"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"3043ed59-d07e-4fed-8743-29aa8ee5eb7a","name":"200 OK - Successful Cancel Mandate - Successfully Cancelled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\":{{mandateId}},\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"https://api.rapidpaycollect.co.za/mandates/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcV29ya1xQcm9qZWN0c1xQYXlzb2Z0IEZyb250IE9mZmljZVxDb2RlXFBheXNvZnRcU2VjdXJlXFBheVNvZnQuQXBpXG1hbmRhdGVzXGNhbmNlbA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 28 May 2019 13:26:49 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"28dd80ba-a022-4567-90aa-e57e682d73d9"}],"id":"2aed3122-7228-4aac-826b-2ca2c6eaa7fd","description":"The following lists simulated test cases for mandates. Mandates submitted via the sandbox url will not be sent to bank, but will have a simulated response from a debtor. Each submission type will have a defining property value which will simulate the expected response from the bank.
\n","event":[{"listen":"prerequest","script":{"id":"5700a3ed-d8d2-4cf1-89e9-99fab2e6a37c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"58c48d01-8466-4fbc-9ebf-5d6c86f4841d","type":"text/javascript","exec":[""]}}],"_postman_id":"2aed3122-7228-4aac-826b-2ca2c6eaa7fd"},{"name":"Collections","item":[{"name":"Submit Collections","event":[{"listen":"test","script":{"id":"6bcbc515-320f-40bc-8e3c-64da380d6db6","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"batchNumber\", data.batchNumber);","pm.variables.get(\"batchNumber\");",""],"type":"text/javascript"}}],"id":"3064e641-6157-4401-bf9b-7ff2f1d850a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"transactionItems\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 100,\r\n \"SequenceType\": 1\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 200,\r\n \"SequenceType\": 1\r\n\t\t}\r\n\t],\r\n\t\"fileHeader\" : {\r\n\t\t\"ProcessDate\" : \"{{processDate}}\",\r\n\t\t\"ClientCode\": \"{{clientCode}}\",\r\n\t\t\"TrackingDays\": \"3\",\r\n\t\t\"ServiceType\": \"1Day\",\r\n\t\t\"BatchDescription\": \"Collections API\",\r\n\t\t\"UniqueId\": \"5399aa8e-c302-4490-9f38-30460875b82f\"\r\n\t}\r\n}"},"url":"https://api.rapidpaycollect.co.za/debicheck","description":"The DebiCheck collections endpoint enables you to collect on mandates that have been accepted.
\nThis request is composed of the following sections:
\nThe BatchFileHeader contains essential information about the batch.
\nBatchFileHeader properties:
\nEach Transaction item has the following properties:
\nThe following data is returned:
\nIf there are any validation errors, the validationsResultMessage will say \"There were validation errors found for the processed batch file.\" In order to view the detailed errors for each specific batch item, save the batchNumber and refer to the \"View Collection Import Validation Results\" request. If everything passed validations, the Validation Result Message will be empty and the Number of unsuccessful transactions will be 0.
\n**Please note: ** The batch will not be processed until it has been confirmed. This enables you to determine if you want to proceed with the collection based on the number of transactions that failed the validation or submit a new collection request.
\n","urlObject":{"path":["debicheck"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"ccf0f7f6-8828-46b9-81a8-c15d28b82c5d","name":"Success response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"transactionItems\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 100\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 200\r\n\t\t}\r\n\t],\r\n\t\"fileHeader\": {\r\n\t\t\"ProcessDate\" : \"{{processDate}}\",\r\n\t\t\"ClientCode\": \"{{clientCode}}\",\r\n\t\t\"TrackingDays\": \"3\",\r\n\t\t\"ServiceType\": \"1Day\",\r\n\t\t\"BatchDescription\": \"Collections API\",\r\n\t\t\"UniqueId\": \"5399aa8e-c302-4490-9f38-30460875b82f\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rapidpaycollect.co.za/debicheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"batchNumber\": \"230381\",\n \"successfulTransactions\": 2,\n \"unsuccessfulTransactions\": 0,\n \"totalTransactions\": 2,\n \"successfulTransactionsAmountTotal\": 132,\n \"unsuccessfulTransactionsAmountTotal\": 0,\n \"grandTotal\": 132,\n \"validationsResultMessage\": \"\",\n\t\"messages\":[],\n\t\"errors\": []\n}"},{"id":"183903b7-18e2-4c91-bbed-59151b121f43","name":"Duplicate rejection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"transactionItems\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 100\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"{{mandateReference}}\",\r\n\t\t\t\"CustomerCode\": \"{{customerCode}}\",\r\n\t\t\t\"Amount\": 200\r\n\t\t}\r\n\t],\r\n\t\"fileHeader\": {\r\n\t\t\"ProcessDate\" : \"{{processDate}}\",\r\n\t\t\"ClientCode\": \"{{clientCode}}\",\r\n\t\t\"TrackingDays\": \"3\",\r\n\t\t\"ServiceType\": \"1Day\",\r\n\t\t\"BatchDescription\": \"Collections API\",\r\n\t\t\"UniqueId\": \"5399aa8e-c302-4490-9f38-30460875b82f\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.rapidpaycollect.co.za/debicheck"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"batchNumber\": \"230380\",\n \"successfulTransactions\": 2,\n \"unsuccessfulTransactions\": 0,\n \"totalTransactions\": 2,\n \"successfulTransactionsAmountTotal\": 132,\n \"unsuccessfulTransactionsAmountTotal\": 0,\n \"grandTotal\": 132,\n \"validationsResultMessage\": \"This batch has been rejected because it is a duplicate\",\n\t\"messages\":[],\n\t\"errors\": []\n}"}],"_postman_id":"3064e641-6157-4401-bf9b-7ff2f1d850a6"},{"name":"Confirm Collections Batch","id":"c293f5ba-2fde-49aa-91e2-27d8c6bfda7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://api.rapidpaycollect.co.za/debicheck/confirm?batchNumber=","description":"After you have done the initial collections submission and received the batch number, if there were any transactions which successfully passed validation, you may either continue with the successful transactions or start over by first fixing any issues with the unsuccessful ones.
\nThis end-point only requires a batch number. The system will do all the validation needed.
\nIt returns any errors which may occur such as:
\nIf all succeeds the system will inform the user via the response. All emails which need to be sent to users, such as authorisation emails, will be done in this step.
\n","urlObject":{"path":["debicheck","confirm"],"host":["https://api.rapidpaycollect.co.za"],"query":[{"description":{"content":"(Required) The batch number
\n","type":"text/plain"},"key":"batchNumber","value":""}],"variable":[]}},"response":[{"id":"de71cd97-2188-42d1-9eb9-9bb6599d46af","name":"Batch Not Found","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.rapidpaycollect.co.za/debicheck/confirm?batchNumber=","host":["https://api.rapidpaycollect.co.za"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"","description":"(Required) The batch number"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"Could not find batch.\"\n ],\n \"errors\": [\n {\n \"errorCode\": \"1000\",\n \"message\": \"Entity Not Found\",\n \"severity\": \"ERROR\"\n }\n ]\n}"},{"id":"8ee2185b-76d0-433c-a582-18d783fd13fa","name":"Batch is awaiting authorisation","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.rapidpaycollect.co.za/debicheck/confirm?batchNumber=","host":["https://api.rapidpaycollect.co.za"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"","description":"(Required) The batch number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \"Batch is waiting for authorization.\"\n ],\n \"errors\": [\n {\n \"errorCode\": \"1002\",\n \"message\": \"You cannot continue with this action because this batch is waiting for authorization.\",\n \"severity\": \"INFO\"\n }\n ]\n}"},{"id":"3841a976-4e67-42bf-a2be-5f7be00446a3","name":"Processed successfully","originalRequest":{"method":"POST","header":[],"url":{"raw":"https://api.rapidpaycollect.co.za/debicheck/confirm?batchNumber=","host":["https://api.rapidpaycollect.co.za"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"","description":"(Required) The batch number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"messages\": [\n \t\"Batch 230368 processed successfully but requires authorisation.\"\n\t],\n \"errors\": []\n}"}],"_postman_id":"c293f5ba-2fde-49aa-91e2-27d8c6bfda7f"},{"name":"View Collection Import Validation Results","id":"5ddbd972-4e3f-48bd-84e5-3ba267bcbeee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://api.rapidpaycollect.co.za/debicheck/validationresults?batchNumber=&filter=1","description":"This end-point simply returns a detailed view of the validation results for a specific batch.
\nIt accepts as a parameter a batch number and a result filter.\nThe result filters are as follows:
\nThe end-point will return the:
\n(Required) The batch number
\n","type":"text/plain"},"key":"batchNumber","value":""},{"description":{"content":"(Optional) If left out, all the results will be retrieved
\n","type":"text/plain"},"key":"filter","value":"1"}],"variable":[]}},"response":[{"id":"0d8c1971-dde0-4dd2-90f7-b58bf1e83338","name":"Failure and success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rapidpaycollect.co.za/debicheck/validationresults?batchNumber=&filter=1","host":["https://api.rapidpaycollect.co.za"],"path":["debicheck","validationresults"],"query":[{"key":"batchNumber","value":"","description":"(Required) The batch number"},{"key":"filter","value":"1","description":"(Optional) If left out, all the results will be retrieved"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"customerCode\": \"Kv002_30\",\n \"reference\": \"0010201908280EE2BC3929\",\n \"cdvResult\": \"Invalid\",\n \"resultMessage\": \"Amount was greater than the maximum collection amount\",\n \"amount\": 130\n },\n {\n \"customerCode\": \"Test16\",\n \"reference\": \"0010201909165FDDD79622\",\n \"cdvResult\": \"Valid\",\n \"resultMessage\": \"\",\n \"amount\": 130\n }\n ],\n \"errors\": [],\n \"messages\": []\n}"},{"id":"66f25014-dc01-43b8-ac32-9fe440c69ea9","name":"All successes","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.rapidpaycollect.co.za/debicheck/validationresults?batchNumber=&filter=1","host":["https://api.rapidpaycollect.co.za"],"path":["debicheck","validationresults"],"query":[{"key":"batchNumber","value":"","description":"(Required) The batch number"},{"key":"filter","value":"1","description":"(Optional) If left out, all the results will be retrieved"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"transactions\": [\n {\n \"customerCode\": \"Test16\",\n \"reference\": \"0010201909165FDDD79622\",\n \"cdvResult\": \"Valid\",\n \"resultMessage\": \"\",\n \"amount\": 130\n },\n {\n \"customerCode\": \"Kv002_30\",\n \"reference\": \"0010201908280EE2BC3929\",\n \"cdvResult\": \"Valid\",\n \"resultMessage\": \"\",\n \"amount\": 2\n }\n ],\n \"errors\": [],\n \"messages\": []\n}"}],"_postman_id":"5ddbd972-4e3f-48bd-84e5-3ba267bcbeee"}],"id":"b1815f95-5bc5-4697-95ac-168736578716","description":"The collections API allows one to collect on accepted mandates.
\n","event":[{"listen":"prerequest","script":{"id":"6a4bc061-ec2b-4c0c-bfca-e6eb81b9fb5d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"05839314-830b-49f6-8926-9273d8fe894c","type":"text/javascript","exec":[""]}}],"_postman_id":"b1815f95-5bc5-4697-95ac-168736578716"},{"name":"Callbacks/Webhooks","item":[{"name":"Initiate a Mandate Including a callback","event":[{"listen":"test","script":{"id":"cc87d4f4-727e-4723-9928-f516d27f2a5b","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}}],"id":"70e3a646-03d4-4721-a758-b9dc3e187dac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{accessToken}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"10\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"callbackUrl\" : \"Enter a valid callback URL\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"0.10\",\n \"maximumCollectionAmount\": \"0.10\",\n \"firstCollectionAmount\": \"\",\n \"FirstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":"https://api.rapidpaycollect.co.za/mandates/initiate","description":"This method is used for initiating a new mandate and to include a callback URL.
\n","urlObject":{"path":["mandates","initiate"],"host":["https://api.rapidpaycollect.co.za"],"query":[],"variable":[]}},"response":[{"id":"9bfa0848-8d32-4fc3-b49c-454f5e6ec595","name":"400 Bad Request - Unsuccessful (CDV Error) Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"callbackUrl\" : \"Enter a valid callback URL\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"debtor.accountNumber\": [\n \"Account number is not valid for First National Bank\"\n ]\n }\n}"},{"id":"6fcd122c-73cf-4f2c-af41-bdd7d0c621d7","name":"400 Bad Request - Unsuccessful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"callbackUrl\" : \"Enter a valid callback URL\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"The request is invalid.\",\n \"errors\": {\n \"contractReference\": [\n \"Contract Reference cannot be longer than 14 characters\"\n ]\n }\n}"},{"id":"c2eb924c-ae33-445c-9422-c0c5e090c90e","name":"200 OK - Successful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"{{clientCode}}\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"{{contractReference}}\",\n \"customerCode\": \"{{customerCode}}\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"callbackUrl\" : \"Enter a valid callback URL\",\n \"debtor\": {\n \"name\": \"{{debtorName}}\",\n \"accountNumber\": \"\",\n \"branchCode\": \"{{debtorBranchCode}}\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"{{debtorPhoneNumber}}\",\n \"emailAddress\": \"{{debtorEmailAddress}}\"\n },\n \"collection\": {\n \"occurrenceId\": \"1\",\n \"collectionFrequency\": \"3\",\n \"collectionDay\": \"01\",\n \"collectionAmount\": \"100\",\n \"maximumCollectionAmount\": \"100\",\n \"firstCollectionAmount\": \"\",\n \"firstCollectionDate\": \"\",\n \"adjustmentCategoryId\": \"\",\n \"adjustmentAmount\": \"\",\n \"adjustmentRate\": \"\",\n\t\"dateAdjustmentAllowed\": \"false\"\n }\n}"},"url":{"raw":"https://api.rapidpaycollect.co.za/mandates/initiate?","host":["https://api.rapidpaycollect.co.za"],"path":["mandates","initiate"],"query":[{"key":"","value":null},{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"requestReference\": \"b6b87e1c-0ea9-4df9-b1e8-257c1beccd55\",\n \"mandateReference\": \"\",\n \"mandateId\": \"004151246032017019205100005030159132020000186049\",\n \"statusId\": 10,\n \"status\": \"Success\",\n \"message\": \"Success\",\n \"errors\": []\n}"}],"_postman_id":"70e3a646-03d4-4721-a758-b9dc3e187dac"}],"id":"b541f6b8-140a-4f7b-9d0d-d2e7bab6ff55","description":"Mandate callbacks allow us to send our clients mandate updates as soon as a mandate status has changed. This removes the need for clients to poll our server for updates.
\nFor for a client to receive a callback on a mandate, the following is required:
\nAfter a mandate has been initiated with a callback URL, we will send all status updates to the provided URL. The callback will be sent in XML format and may look as follows:
\n<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>\n<Response>\n <Result>OK</Result>\n <BatchCode></BatchCode>\n <MandateResults>\n <Result>\n <ContractReference>JOHN001</ContractReference>\n <CustomerCode>JOHN001</CustomerCode>\n <Errors>\n </Errors>\n <Status>\n <Id>3</Id>\n <Name>Accepted</Name>\n </Status>\n <TimeStamp>26/08/2020 00:00:00</TimeStamp>\n </Result>\n </MandateResults>\n</Response>\n<?xml version=\"1.0\" encoding=\"utf-8\" standalone=\"yes\"?>\n<Response>\n <Result>OK</Result>\n <BatchCode></BatchCode>\n <MandateResults>\n <Result>\n <ContractReference>JOHN001</ContractReference>\n <CustomerCode>JOHN001</CustomerCode>\n <Errors>\n </Errors>\n <Status>\n <Id>3</Id>\n <Name>Accepted</Name>\n </Status>\n <TimeStamp>26/08/2020 00:00:00</TimeStamp>\n </Result>\n <Result>\n <ContractReference>JOHN001</ContractReference>\n <CustomerCode>JOHN001</CustomerCode>\n <Errors>\n </Errors>\n <Status>\n <Id>1</Id>\n <Name>Saved</Name>\n </Status>\n <TimeStamp>26/08/2020 00:00:00</TimeStamp>\n </Result>\n </MandateResults>\n</Response>\nSome of the statuses returned include:
\n