The Paysoft API gives developers access to the processing platform used by Paysoft. Developers can use the API to securely submit requests for services using their own software.
\nThe baseUrl variable value for all TEST API calls
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different user name and password from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\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":[],"owner":"6864947","collectionId":"243ba560-c8b8-44a2-810a-854e7ec98d2a","publishedId":"SVtZwmhh","public":true,"customColor":{"top-bar":"FFF","right-sidebar":"808184","highlight":"EC1C24"},"publishDate":"2021-05-06T07:55:49.000Z"},"item":[{"name":"Legacy","item":[{"name":"Payments","item":[{"name":"Payment Request (Approved Beneficiaries)","event":[{"listen":"prerequest","script":{"id":"01fa8967-5d21-49a4-aedb-4e07b32f889f","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"dd8ba047-9eca-470a-8fa1-129f8484bb44","exec":[""],"type":"text/javascript"}}],"id":"0e86f113-45d9-4324-9a64-fe7bdd01360b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A payments request consists of 3 separate sections with a root element with the name APIPaymentsRequest. The Header section contains information relating the payments batch, the Payments sections is a collection of account details to be used as the destination for the payments and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/Payments","description":"Approved Beneficiaries allows you to preload banking details onto the system, thereby ensuring that your customers always use the correct account number when making payments.
\nNote: Always set the BranchCode, BranchHash, AccountNumber and AccountHash to 0
\n","urlObject":{"path":["Payments"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"4946bdc1-f058-4d9e-b7fa-f634bf0ce8d9","name":"Payment Request (Approved Beneficiaries) - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A payments request consists of 3 separate sections with a root element with the name APIPaymentsRequest. The Header section contains information relating the payments batch, the Payments sections is a collection of account details to be used as the destination for the payments and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/Payments","urlObject":{"path":["Payments"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"082bd8ec-9257-4fde-b2f8-5717714b829e","name":"Payment Request (Creditors) - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A payments request consists of 3 separate sections with a root element with the name APIPaymentsRequest. The Header section contains information relating the payments batch, the Payments sections is a collection of account details to be used as the destination for the payments and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/Payments","urlObject":{"path":["Payments"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"33b7681d-bba1-49f5-a72e-fdc40243b56e","name":"Payment Request (Salaries) - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A payments request consists of 3 separate sections with a root element with the name APIPaymentsRequest. The Header section contains information relating the payments batch, the Payments sections is a collection of account details to be used as the destination for the payments and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/Payments","urlObject":{"path":["Payments"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"3ccd0967-e027-403f-9d76-d4ca126a5920","name":"Payment Request (Wages) - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"Users can also subscribe to receiving debit order webhooks when the bank has processed the debit order and returned the result back to Paysoft. This call-back url can be setup as the default call-back url on the client service setup, or it can included in the debit order request using the CallBackUrl field in the request header.
\nIncluding the call-back url in the debit order request header will allow users to encode the call-back url with unique data relating to the specific debit order request.
\nOnce debit order results are received from the bank, this call-back url will be used to send the webhook containing the documented DebitOrderResult object. It will be posted as a url encoded form encoded as multipart/form-data.
\nIt is important to note that should a call-back url be configured or provided, it will return single or multiple results based on how the original batch was received and processed by the bank, therefore users can always expect multiple results in a call-back result.
\nYou can also view the webhook history on the Paysoft portal if users were granted access to it. This will allow users to monitor failures or resend webhooks.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"bddf4ef5-4843-4ccd-bce7-f8cce0cd8fdc","name":"Rejection","originalRequest":{"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nA payments request will submit data relating to a payments batch. A payments batch can be for Creditors, Salaries or Wages. Once a payment batch has been submitted, a CDV check will be performed on the account details provided and any accounts failing that check will be included in the response. Any accounts that passed the CDV check will continue to be processed.
\nIf an account is rejected by a bank (usually because it has been closed) an unpaids response is created and posted back to the call-back URL provided. All response data are submitted as a form data in a POST action (i.e. application/x-www-form-urlencoded) with the key “response”.
\nA payment request has a single Header section and it consists of the following elements:
\nA payment request has a single Payments section with multiple FileContents sections consisting of the following elements:
\nA payment request has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with an extra element named BatchValueSubmitted which contains the total value of the batch submitted (less any accounts that failed the CDV check).
\nIf any of the payment’s FileContents records failed the CDV check, they will be returned as a CDVResults element with a collection of Result elements outlining the reasons for the accounts rejection. The Result section consists of the following elements:
\nPlease note: If any of the accounts passed the CDV check the batch will be accepted and will proceed to be processed
\nDue to the way the banks operate, a payment is assumed to be successful unless an unpaids response is returned. However, it remains useful to subscribe to a callback once a payment has been accepted by the bank to trigger a workflow based on the success of the payment. A complete response is posted back to your server using the CallBackUrl provided in the initial request.
\nUnlike unpaids callbacks, complete callbacks need to be enabled on your client profile in order to be sent. Please contact support@paysoft.co.za to request activation of the complete callback.
\nNote: The complete responses are sent once the bank has accepted the transactions and could be the day before the payment is received by the recipient.
\nThe Response root element will consist of the following elements:
\nThe PaymentResult section consists of the following elements:
\nDue to timeout incidences, the batch loaded callback can be enabled to confirm whether the batch was successfully loaded or not.
\nUnlike unpaids callbacks, batch loaded callbacks need to be enabled on your client profile to be sent. Please contact support@paysoft.co.za to request activation of the Batch Loaded callback.
\nNote: The Batch Loaded response is sent once the batch has successfully been loaded.
\nThe Response root element will consist of the following elements:
\nAn unpaid occurs when the bank rejects a payment. This can happen for many reasons like the recipients account being closed. When this happens, an unpaids response is POSTed back to your server using the CallBackUrl provided in the initial request.
\nThe Response root element will consist of the following elements:
\nThe PaymentResult section consists of the following elements:
\nPayment Integrators have the option to test their integration against the Paysoft Test API, using a predefined list of account numbers. The table which follows lists all predefined test accounts as well as their expected responses.
\nTest accounts should only be processed using the test API Endpoint, test accounts processed against the live service, will be processed as actual CDV requests, and will potentially incur a fee.
\nThe test service only makes provision for testing one account during any given request. Should integrators attempt to send more than one account during a single API request, the service will return an exception.
\nTest records will go through basic request validation, however, they will only pass or fail Check Digit Validation (CDV) or successfully proccess a dummy payment according to their assigned, expected result, as defined in the table which follows.
\nPlease make use of the TEST API to test service.
\nPlease take note of the API Request/Response examples following this table.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"3b0f5632-727d-4a90-8f4a-ddb9c796b21f"},{"name":"Collections","item":[{"name":"Debit Orders","item":[{"name":"Debit Order Request","event":[{"listen":"prerequest","script":{"id":"a12f7bb5-af30-46b5-a939-6455b86dcba6","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"3891f4f7-b980-4e0d-80da-45e58a3f07e1","exec":[""],"type":"text/javascript"}}],"id":"5dd9d2a4-faf8-45b8-928d-6117a8f49c5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A debit order request consists of 3 separate sections with a root element with the name APIDebitOrdersRequest. The Header section contains information relating to the debit order batch, the DebitOrders sections is a collection of account details to be used as the destination for the debit orders and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/DebitOrder","urlObject":{"path":["DebitOrder"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"8e1c0872-a6f7-4d12-91e8-0491dd8e937b","name":"Debit Order Request - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"{{apiKey}}","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"Users can also subscribe to receiving debit order webhooks when the bank has processed the debit order and returned the result back to Paysoft. This call-back url can be setup as the default call-back url on the client service setup, or it can included in the debit order request using the CallBackUrl field in the request header.
\nIncluding the call-back url in the debit order request header will allow users to encode the call-back url with unique data relating to the specific debit order request.
\nOnce debit order results are received from the bank, this call-back url will be used to send the webhook containing the documented DebitOrderResult object. It will be posted as a url encoded form encoded as multipart/form-data.
\nIt is important to note that should a call-back url be configured or provided, it will return single or multiple results based on how the original batch was received and processed by the bank, therefore users can always expect multiple results in a call-back result.
\nYou can also view the webhook history on the Paysoft portal if users were granted access to it. This will allow users to monitor failures or resend webhooks.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"72515afc-1919-4619-b844-0b3f51c4e71b","name":"Rejection","originalRequest":{"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nA debit orders request will submit data relating to a debit order batch. Once a debit order batch has been submitted, a CDV check will be performed on the account details provided and any accounts failing that check will be included in the response. Any accounts that passed the CDV check will continue to be processed.
\nIf an account is rejected by a bank (usually because it has been closed) an unpaids response is created and POSTed back to the call-back URL provided.
\nA debit order request consists of 3 separate sections with a root element with the name APIDebitOrdersRequest. The Header section contains information relating to the debit order batch, the DebitOrders sections is a collection of account details to be used as the destination for the debit orders and the Totals section is used to verify the information being sent is complete and correct.
\nA debit order request has a single Header section and it consists of the following elements:
\nA debit order request has a single DebitOrders section with multiple FileContents sections consisting of the following elements:
\nA debit order request has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with an extra element named BatchValueSubmitted which contains the total value of the batch submitted (less any accounts that failed the CDV check).
\nThe Response root element will consist of the following elements:
\nThe results of the CDV check will be returned as a CDVResults element with a collection of Result elements outlining the reasons for the accounts rejection. The Result section consists of the following elements:
\nPlease note: If any of the accounts passed the CDV check the batch will be accepted and will proceed to be processed
\nDue to the way the banks operate, a debit order is assumed to be successful unless an unpaids response is returned. However, it remains useful to subscribe to a callback once a debit order has been accepted by the bank to trigger a workflow based on the success of the debit order. A complete response is posted back to your server using the CallBackUrl provided in the initial request.
\nUnlike unpaids callbacks, complete callbacks need to be enabled on your client profile in order to be sent. Please contact support@paysoft.co.za to request activation of the complete callback.
\nNote: The complete responses are sent once the bank has accepted the transactions and could be up to two days before the debit order is actioned on the target account.
\nThe Response root element will consist of the following elements:
\nThe DebitOrderResults section consists of the following elements:
\nDue to timeout incidences, the batch loaded callback can be enabled to confirm whether the batch was successfully loaded or not.
\nUnlike unpaids callbacks, batch loaded callbacks need to be enabled on your client profile to be sent. Please contact support@paysoft.co.za to request activation of the Batch Loaded callback.
\nNote: The Batch Loaded response is sent once the batch has successfully been loaded.
\nThe Response root element will consist of the following elements:
\nAn unpaid occurs when the bank rejects a collection. This can happen for many reasons like the recipients account being closed. When this happens, an unpaids response is posted back to your server using the CallBackUrl provided in the initial request.
\nThe Response root element will consist of the following elements:
\nThe DebitOrderResults section consists of the following elements:
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\nSplit payout rules can be defined in the same payload. Split payout rules allow this collection of funds to be paid out to multiple parties when the funds are received.
\nTo configure the split payout rules a Splits element can be included in each of the required FileContents elements. This element will support multiple Split elements containing the split rules that can be used to define how the collection funds should be distributed on payout, allowing you to define the amount or percentage, the account, the reference, and a customer code that should be used.
\nCollections are broken down into 3 services namely;
\n","_postman_id":"a26ca7ab-089e-4d34-a9db-48608727067a"},{"name":"Verifications","item":[{"name":"Contact Enquiry","item":[{"name":"Contact Enquiry Request","id":"a1500ee1-0307-41e6-80f1-40ab3c9278c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A Contact Enquiry request consists of 3 separate sections with a root element with the name ContactEnquiryRequest. The Header section contains information relating to the Contact Enquiry, the Records sections is a collection of details for the contact and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/ContactEnquiry","urlObject":{"path":["ContactEnquiry"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"07ae620d-2b65-4f64-9d4f-20e35bd76e38","name":"Contact Enquiry Request - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","value":"{{apiKey}}","type":"text","description":"{{apiKeyDescription}}"},{"key":"request","value":"A Contact Enquiry request will submit data relating to an enquiry about the contact details for a client.
\nA Contact Enquiry request consists of 3 separate sections with a root element with the name ContactEnquiryRequest. The Header section contains information relating to the Contact Enquiry, the Records sections is a collection of details for the contact and the Totals section is used to verify the information being sent is complete and correct.
\nNote: Id contact enquiry can only process a single id per request.
\nA Contact Enquiry request has a single Header section and it consists of the following elements:
\nA Contact Enquiry Request has a single Records section with multiple FileContents sections consisting of the following elements:
\nA Contact Enquiry Request has has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with a ContactEnquiryResult or ContactEnquiryError element containing results.
\nThe Response root element will consist of the following elements:
\nThe ContactEnquiryApiResult section consists of the following elements:
\nThe Contact section consists of the following elements:
\nThe ContactEnquiryError section consists of the following elements:
\n","_postman_id":"a1806225-5b32-487e-a3e9-94a5546ddd42"},{"name":"Check Digit Verification (CDV)","item":[{"name":"Check Digit Validation Request(CDV)","event":[{"listen":"prerequest","script":{"id":"9fd1abf4-899c-4969-9c7a-c9354a339af4","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"307d54d6-1257-4351-a168-0a302371c57b","exec":[""],"type":"text/javascript"}}],"id":"0fcf9065-24d6-4dff-992a-d6607fba3de0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A CDV request consists of 3 separate sections with a root element with the name APICDVRequest. The Header section contains information relating to the CDV batch, the Records sections is a collection of account details to be verified and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/CDV","urlObject":{"path":["CDV"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fcf9065-24d6-4dff-992a-d6607fba3de0"}],"id":"15f4db6c-77dd-41b0-b7bd-ca465c313164","description":"A CDV request will submit data relating to the verification of a batch of account numbers against a bank supplied algorithm to determine if the account numbers fall within a valid range for that bank.
\nA CDV request consists of 3 separate sections with a root element with the name APICDVRequest. The Header section contains information relating to the CDV batch, the Records sections is a collection of account details to be verified and the Totals section is used to verify the information being sent is complete and correct.
\nA CDV request has a single Header section and it consists of the following elements:
\nA CDV request has a single Records section with multiple FileContents sections consisting of the following elements:
\nA CDV request has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with a CDVResults element containing the validation results.
\nThe Response root element will consist of the following elements:
\nThe Result section consists of the following elements:
\nCDV Integrators have the option to test their integration against the Paysoft Test API, using a predefined list of account numbers. The table which follows lists all predefined test accounts as well as their expected responses.
\nTest accounts should only be processed using the test API Endpoint, test accounts processed against the live service, will be processed as actual CDV requests, and will potentially incur a fee.
\nThe test service only makes provision for testing one account during any given request. Should integrators attempt to send more than one account during a single API request, the service will return an exception.
\nTest records will go through basic request validation, however, they will only pass or fail Check Digit Validation (CDV) according to their assigned, expected result, as defined in the table which follows.
\nPlease make use of the TEST API to test service.
\nPlease take note of the API Request/Response examples following this table.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"15f4db6c-77dd-41b0-b7bd-ca465c313164"},{"name":"ID Number Enrichment","item":[{"name":"ID Number Enrichment Request","event":[{"listen":"prerequest","script":{"id":"a3657b73-9497-4903-9249-bdb8c6a1660c","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"91c8549e-0c6d-40bc-8b0d-01af45b8c964","exec":[""],"type":"text/javascript"}}],"id":"e88bf908-19a3-4369-9db8-29b48c23e94b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"An ID number enrichment request consists of 3 separate sections with a root element with the name IdNumberVerificationRequest. The Header section contains information relating the ID number batch, the Records section holds the data to be enriched and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/IdNumberVerification","urlObject":{"path":["IdNumberVerification"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"d5a6a4c6-4703-4524-89d0-203c24a1f02e","name":"ID Number Enrichment Request - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"{{ApiKey}}","type":"text","description":"{{ApiKeyDesc}}"},{"key":"request","value":"ID number enrichment is a real-time service that enables an ID number to be enriched with related data. This data includes addresses, contact details and deceased indicators.
\nAn ID number enrichment request consists of 3 separate sections with a root element with the name IdNumberVerificationRequest. The Header section contains information relating the ID number batch, the Records section holds the data to be enriched and the Totals
section is used to verify the information being sent is complete and correct.
A Id Number enrichment request has a single Header section and it consists of the following elements:
\nA Id number enrichment request has a single Records section with multiple FileContents sections consisting of the following elements:
\nAn ID number enrichment request has a single Totals section and it consists of the following
elements:
The standard response structure will be returned with an extra element named IdNumberVerificationResult which contains the results.
\nThe Response root element will consist of the following elements:
\nThe IdNumberVerificationResult section consists of the following elements:
\nThe Addresses section contains a collection of Address items consisting of the following elements:
\nThe TelephoneNumbers element contains a collection of TelephoneNumber items consisting of the following elements:
\nThe standard response structure will be returned with a IdNumberVerificationResult element
containing an Error section with the following elements:
The baseUrl variable value for all TEST API calls is;
\n\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"9e2a0d5a-48fa-4162-8961-d2bfdf28fa2e"},{"name":"Batch Bank Account Verification (BANV)","item":[{"name":"Batch Bank Account Verification Request (BANV)","event":[{"listen":"prerequest","script":{"id":"9677e9d1-fac1-41d8-a0d5-af630163cd59","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"71585e3f-67ce-4548-83b6-678f5edaef9d","exec":[""],"type":"text/javascript"}}],"id":"41dc3d13-80fd-40ba-a09c-22f8804188c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A BANV request will submit data relating to the verification of a batch of account numbers against the information provided. Once a batch has been submitted, a CDV check will be performed on the account details provided and any accounts failing that check will be included in the response. Any accounts that passed the CDV check will continue to be processed.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/Verification","urlObject":{"path":["Verification"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"62a16378-2b54-4e1c-93d3-8be1e994f4e3","name":"Batch Account Verification Request - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"request","value":"A BANV request will submit data relating to the verification of a batch of account numbers against the information provided. Once a batch has been submitted, a CDV check will be performed on the account details provided and any accounts failing that check will be included in the response. Any accounts that passed the CDV check will continue to be processed.
\nAs of Version 2, additional fields have been catered for, namely; Email Address, Telephone Number (specifically a mobile number) and Account Type. These fields are optional and are flagged as such in the tables which follow.
\nA BANV request consists of 3 separate sections with a root element with the name APIVerificationRequest. The Header section contains information relating to the BANV batch, the Records sections is a collection of account details to be used for verification and the Totals section is used to verify the information being sent is complete and correct.
\nA BANV request has a single Header section and it consists of the following elements:
\nA BANV request has a single Records section with multiple FileContents sections consisting of the following elements:
\nA BANV request has a single Totals section, and it consists of the following elements:
\nA validation response occurs when the bank returns the result of the bank account verification. When this happens, a validation response is POSTed back to your server using the CallBackUrl provided in the initial request.
\nNote: The validation responses are POSTed back to the CallBackUrl whenever a response is returned by the bank. This is likely to occur multiple times as each bank has different response times.
\nThe Response root element will consist of the following elements:
\nThe BanvResults section consists of the following elements:
\nThe flags of the verification result are a character indication of each of the 8 verification options. Not all banks are able to supply all the information in which case the character will be a blank space. An example Flags return would be: YYYYYYYYYYY which is the equivalent to a result of “A/c exists, ID matches, Inits match, Name matches, A/c open, accepts Dr, accepts Cr & open more than 3 months, Email matches, Mobile matches & Account type matches.”.
\nIf the first 5 flags are “Y” then then account can be considered valid.
\nNote: Names and Initials must be identical to the name or initial the bank has on record otherwise it will not match. If the Initials provided are “WJ” and the bank has just “W” on record, then the initials flag will be displayed as an “N”.
\nThe 11 flag options are:
\nBANV Integrators have the option to test their integration against the Paysoft Test API, using a predefined list of account numbers. The table which follows lists all predefined test accounts as well as their expected responses.
\nTest accounts should only be processed using the test API Endpoint, test accounts processed against the live service, will be processed as actual BANV requests, and will potentially incur a fee.
\nThe test service only makes provision for testing one account during any given request. Should integrators attempt to send more than one account during a single API request, the service will return an exception.
\nTest records will go through basic request validation, however, they will only pass or fail Check Digit Validation (CDV) or Bank Account Verification (BANV) according to their assigned, expected result, as defined in the table which follows.
\nPlease make use of the TEST API to test service.
\nPlease take note of the API Request/Response examples following this table.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"69ac17cc-ea2f-46e0-989c-1f7cd8cf15c1"},{"name":"Real-time Bank Account Verification (BANVR)","item":[{"name":"Real-time Bank Account Verification Request (BANVR)","event":[{"listen":"prerequest","script":{"id":"9677e9d1-fac1-41d8-a0d5-af630163cd59","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"71585e3f-67ce-4548-83b6-678f5edaef9d","exec":[""],"type":"text/javascript"}}],"id":"cea4a2fc-52ab-4ca8-aec9-9e74aac07c3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"A BANVR request consists of 3 separate sections with a root element with the name APIRealTimeVerificationRequest. The Header section contains information relating to the BANVR batch, the Records sections is a collection of account details to be used for verification (only a single account is valid for real-time verification) and the Totals section is used to verify the information being sent is complete and correct.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/RealtimeVerification","urlObject":{"path":["RealtimeVerification"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"19a6a5f7-9f51-4d43-8e6d-bcf244093315","name":"Real-time Bank Account Verification Request (BANVR) - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"request","value":"A BANVR request will submit data relating to the verification of a single account number against the information provided. Real-time account verification has a guaranteed response time from the bank of 60 seconds. If no response has been received after 60 seconds, then no result is returned. Due to the real-time response, no callback will be sent.
\nAs of Version 2, additional fields have been catered for, namely, Email Address, Telephone Number (specifically a mobile number) and Account Type. These fields are optional and are flagged as such in the tables which follow.
\nA BANVR request consists of 3 separate sections with a root element with the name APIRealTimeVerificationRequest. The Header section contains information relating to the BANVR batch, the Records sections is a collection of account details to be used for verification (only a single account is valid for real-time verification) and the Totals section is used to verify the information being sent is complete and correct.
\nA BANVR request has a single Header section and it consists of the following elements:
\nA BANVR request has a single Records section with a single FileContents sections consisting of the following elements:
\nA BANVR request has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with a BanvRealtimeResult element containing the validation results.
\nThe Response root element will consist of the following elements:
\nThe BanvRealTimeResult section consists of the following elements:
\nIf the query was not processed, the Result field will have the text “Unprocessed” and the Flags field will have the text “U”.
\nThe CDVResults element will always be returned regardless of whether the account passed the CDV check or not.
\nThe Result section consists of the following elements:
\nThe flags of the verification result are a character indication of each of the 8 verification options. Not all banks are able to supply all the information in which case the character will be a blank space. An example Flags return would be: YYYYYYYYYYY which is the equivalent to a result of “A/c exists, ID matches, Inits match, Name matches, A/c open, accepts Dr, accepts Cr & open more than 3 months, Email matches, Mobile matches & Account type matches.”.
\nNote: Names and Initials must be identical to the name or initial the bank has on record otherwise it will not match. If the Initials provided are “WJ” and the bank has just “W” on record, then the initials flag will be displayed as an “N”.
\nThe 11 flag options are:
\nBANV-R Integrators have the option to test their integration against the Paysoft Test API, using a predefined list of account numbers. The table which follows lists all predefined test accounts as well as their expected responses.
\nTest accounts should only be processed using the test API Endpoint, test accounts processed against the live service, will be processed as actual BANV-R requests, and will incur a fee.
\nThe test service only makes provision for testing one account during any given request. Should integrators attempt to send more than one account during a single API request, the service will return an exception.
\nTest records will go through basic request validation, however, they will only pass or fail Check Digit Validation (CDV) or Real Time Bank Account Verification (BANV-R) according to their assigned, expected result, as defined in the table which follows.
\nPlease make use of the TEST API to test service.
\nPlease take note of the API Request/Response examples following this table.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"3947f882-13c1-4212-8132-9c984d4ed8bf"}],"id":"2ca42325-a503-4645-a8a2-850edf21fac6","description":"Verfication services for verfying include
\n","_postman_id":"2ca42325-a503-4645-a8a2-850edf21fac6"},{"name":"Batches","item":[{"name":"Batch Cancellation Request","event":[{"listen":"prerequest","script":{"id":"01fa8967-5d21-49a4-aedb-4e07b32f889f","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"dd8ba047-9eca-470a-8fa1-129f8484bb44","exec":[""],"type":"text/javascript"}}],"id":"bfa67186-1772-4085-8d54-a7a4c67d3399","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"\nA batch cancellation request consists of a root element with the name APIBatchCancelRequest. The BatchNumbers sections is a collection of batch numbers to be cancelled.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/BatchCancel","description":"The batch cancellation request allows you to cancel batches that have not reached a certain status in the process.
\nFor automatically matched and collection batches, batches that are still waiting for authorisation, waiting for funds, or waiting for release can still be cancelled. Once the batch has moved beyond these statuses, it has already been released for processing.
\nFor batches using the automatic release feature, batches that are still waiting for authorisation or waiting for funds can still be cancelled. Once the batch has moved beyond these statuses, it has already been released for processing.
\nFor batches using neither of these features and for all all other services, batches that are still waiting for authorisation or waiting for funds can still be cancelled. Once the batch has moved beyond these statuses, it has already been released for processing.
\n","urlObject":{"path":["BatchCancel"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"58a97148-66be-41f1-a034-c735b337d063","name":"Batch Cancellation Request - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error."},{"key":"request","value":"\nContact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"\nA batch status request consists of a root element with the name APIBatchStatusRequest. The BatchNumbers section is a collection of batch numbers to be queried.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/BatchStatus","description":"The batch status request allows you to get batch statuses that have been submitted for processing.
\n","urlObject":{"path":["BatchStatus"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"7028890b-443e-43b7-b66f-c3f40fd2da28","name":"Batch Status Request - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"MyPaysoftSuppliedApiKey","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error."},{"key":"request","value":"\nThese are some of the basic functions available for submitted batches.
\n","_postman_id":"658f804c-b36c-4ff7-9069-ab874772801e"},{"name":"Real-Time Payments","item":[{"name":"Initiate Payment","event":[{"listen":"prerequest","script":{"id":"f707f0d3-3b69-4221-83d0-c72bf7cfe087","exec":["const moment = require('moment');\r","pm.variables.set(\"today\", moment().format(\"YYYYMMDD\"));\r","pm.variables.set(\"amount\", _.random(1, 1000));"],"type":"text/javascript","packages":{},"requests":{}}},{"listen":"test","script":{"id":"8e4d6b36-2d76-4d1c-ac9c-e491c35668f9","exec":["pm.test(\"Status code is 200\", function () {\r"," pm.response.to.have.status(200);\r","});\r","\r","pm.test(\"Response is XML\", function () {\r"," pm.response.to.have.header(\"Content-Type\");\r"," pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"xml\");\r","});\r",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"1e3c1f75-d110-4bfd-b87e-47ec281631dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nUpdated payment statuses can be obtained using the QueryPayment endpoint. This endpoint will request a status directly from the vendor and update the local record status, before returning the status back via the API response.
\nThis is required for payment initiations that do not immediately return a payment result, such as scenarios when a payment is queued for processing and waioting on the vendor.
\nA payment request has a single Header section and it consists of the following elements:
\nA query status request has a single TransactionIdentifiers section with multiple TransactionIdentifier sections consisting of the following elements:
\nThe query payment status request has a single TransactionIdentifiers element with multiple TransactionIdentifier elements. These identifiers refer to the TransactionId returned in the original PaymentResult returned from the payment initiation request. Using multiple TransactionIdentifier elements will query multiple transactions for updates and return a single response containing multiple PaymentResult elements.
\nThe response returned will be the same as the documented PaymentResult element. No CDV checks will be performed which is different to the original payment initiation request.
\n","urlObject":{"path":["RealtimePayments","QueryPayment"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"fec199cd-ccb3-4100-998f-90eed3e83427","name":"Query Payment Status","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nOnce a duplicate is encountered, a duplicate can be accepted via the AcceptDuplicate endpoint. This endpoint will send a request directly to the vendor to accept the duplicate and process it. This request will update the local transaction record, before returning the status back via the API response. A new PaymentResult element containing the updated payment status will be returned.
\nA payment request has a single Header section and it consists of the following elements:
\nAn accept duplicate request has a single TransactionIdentifiers section with multiple TransactionIdentifier sections consisting of the following elements:
\nThe accept duplicate request has a single TransactionIdentifiers element with multiple TransactionIdentifier elements. These identifiers refer to the TransactionId returned in the original PaymentResult returned from the payment initiation request. Using multiple TransactionIdentifier elements will accept multiple duplicate transactions and return a single response containing multiple PaymentResult elements.
\nThe response returned will be the same as the documented PaymentResult element. No CDV checks will be performed which is different to the original payment initiation request.
\n","urlObject":{"path":["RealtimePayments","AcceptDuplicate"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"d7d5ac0e-8814-4f8e-aae2-c6446cec5ea6","name":"Accept Duplicate Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nOnce a duplicate is encountered, a duplicate can be rejected via the RejectDuplicate endpoint. This endpoint will send a request directly to the vendor to reject the duplicate and process it as an unpaid. This request will update the local transaction record, before returning the status back via the API response. A new PaymentResult element containing the updated payment status will be returned.
\nA payment request has a single Header section and it consists of the following elements:
\nA reject duplicate request has a single TransactionIdentifiers section with multiple TransactionIdentifier sections consisting of the following elements:
\nThe reject duplicate request has a single TransactionIdentifiers element with multiple TransactionIdentifier elements. These identifiers refer to the TransactionId returned in the original PaymentResult returned from the payment initiation request. Using multiple TransactionIdentifier elements will reject multiple duplicate transactions and return a single response containing multiple PaymentResult elements.
\nThe response returned will be the same as the documented PaymentResult element. No CDV checks will be performed which is different to the original payment initiation request.
\n","urlObject":{"path":["RealtimePayments","RejectDuplicate"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"32a523d2-3fd5-4729-b648-0daa57092e64","name":"Reject Duplicate Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nOnce a payment is complete, a proof of payment can be requested directly from the vendor using the original TransactionId via the RequestProofOfPayment endpoint. This endpoint will send a request directly to the vendor to send the proof of payment with the details provided. Currently the request of a proof of payment is only supported via e-mail and only proof of payments requested with the original initiation will support sending SMS's. This request will not store the proof of payment, but the local record will be updated with the new proof of payment details requested, before returning the status back via the API response. A new ProofOfPaymentResults element containing the ProofOfPaymentResult will be returned containing the request result and the original TransactionId and TransactionReference.
\nA payment request has a single Header section and it consists of the following elements:
\nA proof of payments request has a single TransactionIdentifiers section with multiple TransactionIdentifier sections consisting of the following elements:
\nThe proof of payments request has a single TransactionIdentifiers element with multiple TransactionIdentifier elements. These identifiers refer to the TransactionId returned in the original PaymentResult returned from the payment initiation request. Using multiple TransactionIdentifier elements will request proof of payment for multiple transactions using the same e-mail address supplied for all transactions. It wil return a single response containing multiple ProofOfPaymentResult elements.
\nThe response returned will be a ProofOfPaymentResults element containing multiple ProofOfPaymentResult elements.These elements will be populated with original TransactionId and TransactionReferences.
\n","urlObject":{"path":["RealtimePayments","RequestProofOfPayment"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"9044715d-36ad-4187-945c-b38a5369e01e","name":"Request Proof Of Payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nOnce a proof of payment was requested, a proof of payment can be retrieved directly from the vendor using the original TransactionId via the RetrieveProofOfPayment endpoint. This endpoint will send a request directly to the vendor to retrieve the original proof of payment. This request will not store the proof of payment, but will return via the API response as a base64 encoded string. This string can be converted to bytes and written to a physical file if required. A new ProofOfPaymentResults element containing the ProofOfPaymentResult will be returned containing the request result and the original FileName, FileContents, TransactionId and TransactionReference.
\nA payment request has a single Header section and it consists of the following elements:
\nA proof of payments request has a single TransactionIdentifiers section with multiple TransactionIdentifier sections consisting of the following elements:
\nThe proof of payments request has a single TransactionIdentifiers element with multiple TransactionIdentifier elements. These identifiers refer to the TransactionId returned in the original PaymentResult returned from the payment initiation request. Using multiple TransactionIdentifier elements will retrieve proof of payments for multiple transactions. It wil return a single response containing multiple ProofOfPaymentResult elements.
\nThe response returned will be a ProofOfPaymentResults element containing multiple ProofOfPaymentResult elements. These elements will be populated with the original FileName, FileContents, TransactionId and TransactionReferences.
\n","urlObject":{"path":["RealtimePayments","RetrieveProofOfPayment"],"host":["https://sandbox.paysoft.co.za/api"],"query":[],"variable":[]}},"response":[{"id":"b1c506d0-5296-47b9-9f2b-af88f305a65b","name":"Retrieve Proof Of Payment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[{"key":"key","type":"text","value":"MyPaysoftSuppliedApiKey"},{"key":"request","type":"text","value":"\nRequired
\n"},{"key":"transactionIdentifier","value":"179047078021081093141196044019048175038229028207","type":"text","uuid":"3711c58f-3635-4285-bb74-62b95b5b8ee3","description":"Required
\n"}]},"url":"https://sandbox.paysoft.co.za/api/RealtimePayments/GetPayment/","description":"The Get Payment endpoint allows users to request detailed information available on a specific transaction. This endpoint requires the transaction identifier as a parameter along with a valid API key.
\nThis endpoint will perform an exact match on the transaction identifier only.
\nThe response will consist of an XML payload containing a single Response element and a collection TransactionResults element. Within the TransactionResults will be Result elements for each record matching the transaction identifier.
\nRequired
\n"},{"key":"clientCode","value":"ZER001","type":"text","uuid":"f505191c-32a9-4b2f-85be-eb2b90db9e23","description":"Required
\n"},{"key":"reference","value":"040b7dc9-cf2f-4b14-81ff-af70097d70ec","type":"text","uuid":"9f2cb42a-d49b-4238-a9dc-5d85b8c570e4","description":"Optional - Reference, ContraReference or UniqueId
\n"}]},"url":"https://sandbox.paysoft.co.za/api/RealtimePayments/LookupPayment/","description":"The Lookup Payment endpoint allows users to request summarised information available on a specific client code and transaction reference. This endpoint requires the client code and transaction reference as a parameters, along with a valid API key.
\nThis endpoint will perform an exact match on the reference, uniqueid or contra reference, for the given client code and return the top 15 results, if any.
\nThe response will consist of an XML payload containing a single Response element and a collection TransactionResults element. Within the TransactionResults will be Result elements for each record matching the transaction identifier.
\nRequired
\n"},{"key":"date","value":"{{today}}","type":"text","uuid":"3711c58f-3635-4285-bb74-62b95b5b8ee3","description":"Required - Date format yyyy-MM-dd
\n"},{"key":"clientCode","value":"ZER001","type":"text","uuid":"59d31055-1c0d-41fb-8671-09d37fd26476","description":"Required
\n"},{"key":"serviceTypeCode","value":"SDV","type":"text","uuid":"f505191c-32a9-4b2f-85be-eb2b90db9e23","description":"Optional - Possible values are RTC, SDV
\n"},{"key":"result","value":"WaitingForProvider","type":"text","uuid":"9f2cb42a-d49b-4238-a9dc-5d85b8c570e4","description":"Optional - Complete, Rejected, WaitingForProvider, Duplicate
\n"},{"key":"query","value":"","type":"text","uuid":"99fed23d-15d6-4ac6-b216-808a9c7d0407","description":"Optional
\n"},{"key":"page","value":"1","type":"text","uuid":"63b4fc72-1623-495a-b8c2-d9e194e64c7e"},{"key":"pageSize","value":"15","type":"text","uuid":"b1a8a433-9c99-4aca-b200-2e0bf0f48d46","description":"Maximum 100 records per page.
\n"}]},"url":"https://sandbox.paysoft.co.za/api/RealtimePayments/SearchPayments/","description":"The Search Payment endpoint allows users to request summarised information available on a specific date. This endpoint requires a date parameter, along with a valid API key. Optional parameters can also be defined for the service type, result and client code, and all results will be restricted to linked clients with view history permissions.
\nThis endpoint will perform an exact match on the date, service type, result or client code, and will return paginated results, if any.
\nThe response will consist of an XML payload containing a single Response element and a collection TransactionResults element. Within the TransactionResults will be Result elements for each record matching the transaction identifier.
\nAs an alternative to querying the payment status, users can opt-in to use webhooks which will allow results to be returned asynchronously. This call-back url can be setup as the default call-back url on the client service setup, or it can be included in the payment initiation request using the CallBackUrl field in the request header.
\nIncluding the call-back url in the payment initiation request header will allow users to encode the call-back url with unique data relating to the specific payment initiation request.
\nOnce payment results are received from the provider, this call-back url will be used to send the webhook containing the documented PaymentResult object. It will be posted as a url encoded form encoded as multipart/form-data.
\nIt is important to note that should a call-back url be configured or provided, there will be no need to poll the query endpoint for payment results and results will be relayed as received from the provider. The ability to query payment results will still be available as a fallback mechanism which can still be used should the payment result not come back in a timeous fashion.
\nYou can also view the webhook history on the Paysoft portal if users were granted access to it. This will allow users to monitor failures or resend webhooks.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"5fad7c09-9ceb-4c57-a1df-d2fba0877c2a","name":"Rejection 1","originalRequest":{"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nA payments request will submit data relating to a payments batch. Once a payment batch has been submitted, a CDV check will be performed on the account details provided and any accounts failing that check will be included in the response. Any accounts that passed the CDV check will continue to be processed.
\nA payment request has a single Header section and it consists of the following elements:
\nA payment request has a single Payments section with multiple FileContents sections consisting of the following elements:
\nPlease note: The number of payments are currently limited to 1 FileContents element due to the nature of providers accept requests.
\nA payment request has a single Totals section, and it consists of the following elements:
\nThe standard response structure will be returned with an extra element named BatchValueSubmitted which contains the total value of the batch submitted (less any accounts that failed the CDV check).
\nIf any of the payment’s FileContents records failed the CDV check, they will be returned as a CDVResults element with a collection of Result elements outlining the reasons for the accounts rejection. The Result section consists of the following elements:
\nPlease note: If any of the accounts passed the CDV check the batch will be accepted and will proceed to be processed.
\nThe PaymentResult section consists of the following elements:
\nPayment results can be descript as follows:
\nThe following characters are permitted in references and text fields.
\nThe following vendor results, with a few exceptions, are treated as rejections since they result in transactions not processing. This will result in a payment result of Rejected.
\nThere are however warning level results which will result in the transaction still processing, but remain in a duplicate state that requires further action to process the transaction. These will result in a payment result of Duplicate.
\nThe following error codes can be returned from the vendor distribution system.
\nThe following error codes can be returned from the vendor electronic payment system.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different API Key from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"601681d6-95a6-400e-be5c-8b2359c68b4b"}],"id":"db476ff3-0af7-4f2d-9f5f-40e96f50a9fb","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\nAll request and response data are submitted as a form data in a POST action (i.e. application/x-www-form-urlencoded) with the key “response”. The API key will use the key “key”.
\nThe baseUrl variable value for all TEST API calls
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different user name and password from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","_postman_id":"db476ff3-0af7-4f2d-9f5f-40e96f50a9fb"},{"name":"Latest","item":[{"name":"Authentication","item":[{"name":"Get Access Token","event":[{"listen":"test","script":{"id":"b1632ee1-4dc5-40ee-8a70-62ac29492d2b","exec":["var data = JSON.parse(responseBody);\r","pm.collectionVariables.set(\"accessToken\", data.access_token);\r","pm.variables.set(\"accessToken\", data.access_token);\r","\r","pm.collectionVariables.get(\"accessToken\");\r","pm.variables.get(\"accessToken\");"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"105f49e2-0080-47e6-a894-3abaa2bb7f01","exec":[""],"type":"text/javascript"}}],"id":"9c479b38-160f-45ff-8c15-f08aeca0da96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"userName","value":"MyPaysoftSuppliedUsername","type":"text","description":"The user name
\n"},{"key":"password","value":"MyPaysoftSuppliedPassword","type":"text","description":"The password assosiated with the user name
\n"}]},"url":"https://sandbox-api.paysoft.co.za/token","description":"Get access token endpoint to retrive access token using the userName and password
\n","urlObject":{"path":["token"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"c3ef44a9-68ee-4b8c-b854-55e31d127d38","name":"Get Access Token - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text"},{"key":"userName","value":"MyPaysoftSuppliedUsername","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"{{ApiUrl}}/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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1363-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1363-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Wed, 25 Oct 2023 08:48:22 GMT"},{"key":"Content-Length","value":"471"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"RaelEpHc9-RQquM-9IcQXUix3C4LW7SWa10oevjf4Nt22a57dmh3qzJAAqx1Va7aAIDpttxw2u-h6Vwyj0B4qLIEppniZsIIdHDwDDmo8XoRt-Zs-jNH9Rsj4RWuHkuJ-wxuY9JTWuDP49KkdnDt3ZklVjGoJstBg4rJBYFPQuMfC6fIrIM9HTAfG0mFEbnf6zNOUXBS4VWa3brAbcoQDi8YPMTeTuWu83cWbt9ydpOjE6X_8Tac6EP1TUzalrlqdDzYVucxTQUmCnUMy24-VtynROk0TDyFcmYssFc_UzacxCFDM8_1JB_kqZXNuo6Q7YwXz7KRdqH3qCnjmHXd92ZlVxIfME3geAynIzPp0Nji3gGVxm9OQJtmMKDi6IOPfGP1P-LQ2CdWEPc9LlTYU2hYFUg\",\n \"token_type\": \"bearer\",\n \"expires_in\": 86399\n}"},{"id":"8cf3ed41-50d0-4a4a-af25-614abb838bcc","name":"Get Access Token - Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","disabled":true},{"key":"userName","value":"MyPaysoftSuppliedUsername","type":"text"},{"key":"password","value":"{{password}}","type":"text"}]},"url":"{{ApiUrl}}/token"},"status":"Bad Request","code":400,"_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":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1363-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1363-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Wed, 25 Oct 2023 08:48:56 GMT"},{"key":"Content-Length","value":"34"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"unsupported_grant_type\"\n}"}],"_postman_id":"9c479b38-160f-45ff-8c15-f08aeca0da96"}],"id":"2e29c554-d1c3-4b0c-b99c-2a059d604f0e","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 Paysoft '/token' authentication end point with the following parameters:
\ngrant_type : password
userName : \"Your username\"
password : \"Your password\"
This endpoint can be used to obtain a list of current payment beneficiaries for creditors (PPREFTCRE). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"EFTRTC"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"a2a2f687-766a-4898-b961-825ade1ad53f","name":"Get List of Payment Realtime EFT Beneficiaries - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=EFTRTC&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"EFTRTC"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": null,\n \"pageCount\": 1,\n \"pageNumber\": 1,\n \"pages\": [],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": false,\n \"showPreviousPage\": false,\n \"totalResults\": 1\n },\n \"results\": [\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"Joe123\",\n \"endDate\": null,\n \"id\": \"032023205057250035232254240138044204072083124153\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Joe Soap\",\n \"recurringPeriod\": 0,\n \"reference\": \"RTC-R\",\n \"scheduleType\": 0,\n \"serviceCode\": \"EFTRTC\",\n \"startDate\": null,\n \"tokenHash\": \"A4CC0489E420CACA3E21B5EFE4F245798DB001C8\"\n }\n ]\n}"},{"id":"a1f41a64-2222-4b0f-9ed9-55f8495defe0","name":"Get List of Payment Realtime EFT Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=EFTRTC&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"EFTRTC"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid client code PSZER001xx\"\n}"}],"_postman_id":"119a5d49-b825-40e4-9c2a-7e1aade13ef0"},{"name":"Get List of Payment Creditor Beneficiaries","id":"d91487a3-da44-499e-a4dc-efe65fb0c0a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTCRE&query=&page=1&pageSize=15","description":"This endpoint can be used to obtain a list of current payment beneficiaries for creditors (PPREFTCRE). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTCRE"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"ceeeee47-2deb-432a-9170-a860b1c43b54","name":"Get List of Payment Creditor Beneficiaries- Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTCRE&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTCRE"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 13:00:33 GMT"},{"key":"Content-Length","value":"7190"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": \"2\",\n \"pageCount\": 467,\n \"pageNumber\": 1,\n \"pages\": [\n {\n \"cssClass\": \"currentPage\",\n \"pageNumber\": \"1\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"2\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"3\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"4\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"5\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"6\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"7\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"8\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"9\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"10\",\n \"pageUrl\": null\n }\n ],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": true,\n \"showPreviousPage\": false,\n \"totalResults\": 7003\n },\n \"results\": [\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"2OCEANS\",\n \"endDate\": null,\n \"id\": \"072204206063106228204250082230039124010209070234\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"2 OCEANS AUTOMATION\",\n \"recurringPeriod\": 2,\n \"reference\": \"A SPAUN A18\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"6C8EB68569E451CF0B0720FA6BC9B94C05CFE4F6\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"2OCEANS\",\n \"endDate\": null,\n \"id\": \"104083034223025027192219025251165078172054179228\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"2 OCEANS AUTOMATION\",\n \"recurringPeriod\": 2,\n \"reference\": \"A SPAUN A18\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"5B98322CDFEE80A76078EA6107702217705A47FB\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"2OCEANS\",\n \"endDate\": null,\n \"id\": \"183250063035019195197034220184133074164246116106\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"2 OCEANS AUTOMATION\",\n \"recurringPeriod\": 2,\n \"reference\": \"A SPAUN A18\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"1B2F9F2F135BB03A6B2EF0A03E9ECCF395918FED\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"2OCEANS\",\n \"endDate\": null,\n \"id\": \"214139215177089127190254041228002227142034062186\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"2 OCEANS AUTOMATION\",\n \"recurringPeriod\": 2,\n \"reference\": \"A SPAUN A18\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"856BCE7439DE3097F1462258D129791A6FD509A1\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"STJAMES\",\n \"endDate\": null,\n \"id\": \"057244150125202059082147145054026252056054150200\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"29 ON ST JAMES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV13966\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"21BF2F8E14678F7B56D26B66A146758430FC9794\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"STJAMES\",\n \"endDate\": null,\n \"id\": \"160084080159246136121063100103166040003235001145\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"29 ON ST JAMES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV13966\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"2002AD9AB342B4732CCE686B84149AF427D2908F\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"STJAMES\",\n \"endDate\": null,\n \"id\": \"080135219128169101072122074037084207206140250061\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"29 ON ST JAMES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV13966\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"37E3907380EBF7D2C58A0F89E8E64EE7C05250A3\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"STJAMES\",\n \"endDate\": null,\n \"id\": \"093228134224179232090098164201006106234068241029\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"29 ON ST JAMES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV13966\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"E76B944C25AFC30F2C36480D8B11325C54137724\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"3PALM01\",\n \"endDate\": null,\n \"id\": \"202089068006060054079175211082116084200199133035\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"3 PALMS GUEST HOUSE\",\n \"recurringPeriod\": 2,\n \"reference\": \"3P-191107-0\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"D12A11DA33903668ECC6AAC18068EB35CEF5E616\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"3PALM01\",\n \"endDate\": null,\n \"id\": \"129233227020030189027031198245204042132168039070\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"3 PALMS GUEST HOUSE\",\n \"recurringPeriod\": 2,\n \"reference\": \"3P-191107-0\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"5B3E11D6BF45F914DDE7974B2BB5B7D301D143E1\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"3PALM01\",\n \"endDate\": null,\n \"id\": \"127219007177238114178187171223180041063242162005\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"3 PALMS GUEST HOUSE\",\n \"recurringPeriod\": 2,\n \"reference\": \"3P-191107-0\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"C08D0B3684D40E7F42798949F717D458F6CFB879\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"3PALM01\",\n \"endDate\": null,\n \"id\": \"088018154167103128006227034094042148075100046137\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"3 PALMS GUEST HOUSE\",\n \"recurringPeriod\": 2,\n \"reference\": \"3P-191107-0\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"5865598B963669BB718816B948CED946123DBD45\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"37ONC01\",\n \"endDate\": null,\n \"id\": \"192189029001002170063107028173249059018176236081\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"37 ON CHARLES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV 30\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"292A91EB3AC870368573E759FB21F4A215EB3484\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"37ONC01\",\n \"endDate\": null,\n \"id\": \"148031081148064107020182080024026008152185076117\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"37 ON CHARLES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV 30\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"06931DA3A7F024F96A631AA8B28511FCAF7B93AB\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"37ONC01\",\n \"endDate\": null,\n \"id\": \"166110228162127127025137218129016114046169231168\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"37 ON CHARLES\",\n \"recurringPeriod\": 2,\n \"reference\": \"INV 30\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTCRE\",\n \"startDate\": null,\n \"tokenHash\": \"BB9F709BF706CE48BBA43DAF1670623ED5363811\"\n }\n ]\n}"},{"id":"27d00cef-d785-40dd-91a9-cb438bc400ee","name":"Get List of Payment Creditor Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=ZER001&service=PPREFTCRE&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"ZER001"},{"key":"service","value":"PPREFTCRE"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 12:59:31 GMT"},{"key":"Content-Length","value":"40"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid client code Zer001\"\n}"}],"_postman_id":"d91487a3-da44-499e-a4dc-efe65fb0c0a8"},{"name":"Get List of Payment Salary Beneficiaries","id":"17bb0689-1028-4b68-ab33-f547fa9646de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTSAL&query=&page=1&pageSize=15","description":"This endpoint can be used to obtain a list of current payment beneficiaries for salaries (PPREFTSAL). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTSAL"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"9c80482d-eb16-48f0-a21c-3b03d5164ed9","name":"Get List of Payment Salary Beneficiaries - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTSAL&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTSAL"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 13:01:59 GMT"},{"key":"Content-Length","value":"6676"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": \"2\",\n \"pageCount\": 2,\n \"pageNumber\": 1,\n \"pages\": [\n {\n \"cssClass\": \"currentPage\",\n \"pageNumber\": \"1\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"2\",\n \"pageUrl\": null\n }\n ],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": true,\n \"showPreviousPage\": false,\n \"totalResults\": 17\n },\n \"results\": [\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": 15000.5,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA2\",\n \"endDate\": null,\n \"id\": \"019101221016075103137144219212060136146198194016\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 2\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 2\",\n \"scheduleType\": 1,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"45B836C16D8CFA3D94BA2E0DAB2093\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"123\",\n \"endDate\": null,\n \"id\": \"190114020080219218233177242061186027250142041039\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Master\",\n \"recurringPeriod\": 0,\n \"reference\": \"Master\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"DE7E90362354F368A4D07BF39D544DCC8028C8F1\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"236005\",\n \"endDate\": null,\n \"id\": \"150134116144094064099060061203159251111102131028\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Test12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"4300228741V00012010\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"0F5D2A7E2853721322A369C3132A6E6F5A94CF78\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"236005\",\n \"endDate\": null,\n \"id\": \"097046030012051047184170185063129066213039174213\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Test12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"4300228741V00012010\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"B2D9B5B4A355CE71E4C6DA63C40B26B62269CF61\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"236005\",\n \"endDate\": null,\n \"id\": \"030077051244033140005093080163017148002176059033\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Test12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"4300228741V00012010\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"44DC5A63429B7B3C654F4D62FFE8FB68B272A785\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"236005\",\n \"endDate\": null,\n \"id\": \"182041175203003082110011115231178067240234237125\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Test12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"4300228741V00012010\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"E225B900565B2488E7B04482F2A4F12D2E164988\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"236005\",\n \"endDate\": null,\n \"id\": \"131169016204073132208216134105121239158138036251\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Test12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"4300228741V00012010\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"467BE49F7C388FF44DEBA69DEE43C7D341CAE34D\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"041049171198129221225047091014074062076045177193\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"818EE1FAE7E2DEA16BC06AE7C013DA1C15276CC3\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"085047078077101109079160199073172141055081252182\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"992E1AD1E7B2FF57D0CC41939851FF6462E0936A\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"001047210102186229216251058138005238102000163065\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"C5D76A2A245E954FCFB6FC5F15220B6F651059B4\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"118140177140246197135026071196031225122149115032\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"60190B332EC6900642FFD8E1B1EF9440DC5A7C6C\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"171120207119107249237054029241021005167031161182\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"3A45F95676F0B5451106B23208C8DC44405276CE\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"143162018186047222067170208050129241128043228159\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"98D9E6A2CAD2C5BEF7FBB952740804CAF6B03A96\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"012084189141124009095176247200105243171055048092\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"CA50E69BF15656A343AD5B503E637AE7A932CBFF\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1111\",\n \"endDate\": null,\n \"id\": \"057122104217142051084158196005227246145069201174\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"TEST12345\",\n \"recurringPeriod\": 0,\n \"reference\": \"123465\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"C0F9BE94BEDAABB5E4EDC8E15E448A4651F9CBFB\"\n }\n ]\n}"},{"id":"9e36b74c-5097-43a2-9bb6-529f45de9101","name":"Get List of Payment Salary Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=ZER001&service=PPREFTSAL&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"ZER001"},{"key":"service","value":"PPREFTSAL"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 13:04:20 GMT"},{"key":"Content-Length","value":"61"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"17bb0689-1028-4b68-ab33-f547fa9646de"},{"name":"Get List of Payment Wages Beneficiaries","id":"d390caa7-46cc-49a2-a85b-80008d9c2bb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTWAG&query=&page=1&pageSize=15","description":"This endpoint can be used to obtain a list of current payment beneficiaries for wages (PPREFTWAG). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTWAG"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"187d626c-840f-46cc-a9d3-91242def7f03","name":"Get List of Payment Wages Beneficiaries- Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=PSZER001&service=PPREFTWAG&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"PPREFTWAG"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 13:03:21 GMT"},{"key":"Content-Length","value":"6959"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": \"2\",\n \"pageCount\": 2,\n \"pageNumber\": 1,\n \"pages\": [\n {\n \"cssClass\": \"currentPage\",\n \"pageNumber\": \"1\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"2\",\n \"pageUrl\": null\n }\n ],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": true,\n \"showPreviousPage\": false,\n \"totalResults\": 16\n },\n \"results\": [\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"123 update\",\n \"endDate\": null,\n \"id\": \"237089037136148197112107012077083063008159011164\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"213 AUdit\",\n \"recurringPeriod\": 2,\n \"reference\": \"test\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"B4E8E531CDC50C1AA6ECA83905D475\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": null,\n \"id\": \"212234132011085024163160236099184213247240200153\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"1D96C9EECA68DAA781C509E39C5D21\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": \"2013-03-04T00:00:00\",\n \"id\": \"227158078059232241046205207255043109181134209120\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": \"2013-02-25T00:00:00\",\n \"tokenHash\": \"27FA780126DE943AB6E4A715C74DD2\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": \"2013-03-03T00:00:00\",\n \"id\": \"036088191093148214028065171013160141142076171151\",\n \"installments\": 7,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": \"2013-02-25T00:00:00\",\n \"tokenHash\": \"076CC9F0B4D87AB81A924A32A52824C480700CCE\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": \"2013-03-03T00:00:00\",\n \"id\": \"119212170240224140048185213146134223032209186082\",\n \"installments\": 7,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": \"2013-02-25T00:00:00\",\n \"tokenHash\": \"C8C5FEA9B50BB9666735A2727F6EBA3AE076C8A9\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": \"2013-03-03T00:00:00\",\n \"id\": \"243180228201141102097146228131233033106103211069\",\n \"installments\": 7,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": \"2013-02-25T00:00:00\",\n \"tokenHash\": \"44CF5D55124A083E46A288ADEEC72DC5D7377749\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA1\",\n \"endDate\": \"2013-03-03T00:00:00\",\n \"id\": \"250038123234089004217252153086188062048176077109\",\n \"installments\": 7,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 1\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 1\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": \"2013-02-25T00:00:00\",\n \"tokenHash\": \"5415A4093EB0F3CA8518C40A93A2C565169349FB\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": 2500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA2\",\n \"endDate\": \"2014-04-01T00:00:00\",\n \"id\": \"028205153140118112182233095069082158119037132091\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 2\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 2\",\n \"scheduleType\": 1,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"A4A875ECD7B08C8AF5A6B036808D237A5584BCBB\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": 2500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA2\",\n \"endDate\": \"2014-04-01T00:00:00\",\n \"id\": \"060066029088103193169018158174175044098040007088\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 2\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 2\",\n \"scheduleType\": 1,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"71A0456A24973290996E72E2F4A88374AECF951F\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"20151001\",\n \"endDate\": null,\n \"id\": \"031192085184035074139103159158184026170045196201\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Joe Bloggs\",\n \"recurringPeriod\": 2,\n \"reference\": \"PeachPayments\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"AE65825503D848B3AE7F2DD31FE9FA537D5FD2DA\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"20151001\",\n \"endDate\": null,\n \"id\": \"211114148059013191051082233232242232055090184219\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Joe Bloggs\",\n \"recurringPeriod\": 2,\n \"reference\": \"PeachPayments\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"37EED860024233181060A0FF535473DCFEF8365B\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": 0.1,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"John\",\n \"endDate\": null,\n \"id\": \"214171084002180221010009044224254248222099251073\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"John Pay Beneficiary\",\n \"recurringPeriod\": 0,\n \"reference\": \"Pay beneficiaries\",\n \"scheduleType\": 1,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"BF1FE4B2BFE57922371BA36AC8B645A6944B9663\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": 20,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"UNIQUE\",\n \"endDate\": null,\n \"id\": \"088020008005228200021067054097038096175195074046\",\n \"installments\": null,\n \"isActive\": false,\n \"name\": \"Test Beneficiary\",\n \"recurringPeriod\": 0,\n \"reference\": \"TEST\",\n \"scheduleType\": 1,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"C8B3197A3E0DF91609C27449904F7B341B85DAD0\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"UNIQUE\",\n \"endDate\": null,\n \"id\": \"037185094068233018182027080150013045229044092191\",\n \"installments\": null,\n \"isActive\": false,\n \"name\": \"Test Beneficiary\",\n \"recurringPeriod\": 0,\n \"reference\": \"TEST\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"C1FFE38E0FC9B22F622AE7AB0A176B6D0F53F8B8\"\n },\n {\n \"approvedBeneficiaryCode\": null,\n \"accountType\": 1,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"UNIQUE\",\n \"endDate\": null,\n \"id\": \"000086255198208047148115050049096155040104111144\",\n \"installments\": null,\n \"isActive\": false,\n \"name\": \"Test Beneficiary\",\n \"recurringPeriod\": 0,\n \"reference\": \"TEST\",\n \"scheduleType\": 0,\n \"serviceCode\": \"PPREFTWAG\",\n \"startDate\": null,\n \"tokenHash\": \"BF847600D458C5CA80E5E56D344F5CBA369AA4BE\"\n }\n ]\n}"},{"id":"6fad8453-6865-45c2-b37a-5de7e17f424a","name":"Get List of Payment Wages Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments?client=ZER001&service=PPREFT&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments"],"query":[{"key":"client","value":"ZER001"},{"key":"service","value":"PPREFT"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1361-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Tue, 24 Oct 2023 13:05:22 GMT"},{"key":"Content-Length","value":"41"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid service code PPREFT\"\n}"}],"_postman_id":"d390caa7-46cc-49a2-a85b-80008d9c2bb5"}],"id":"55e0d6ed-5869-4161-a13f-e1472cd42dd7","description":"These endpoints can be used to obtain a list of current payment beneficiaries. Payments are broken down into four services, namely;
\nTo make a successful call, the service code and the full client code parameter are required.
\nExample
\nThe request structure consists of 5 keys to be passed in as parameters:
\nThe response will be a JSON object with the following properties:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nCreate beneficiaries based on schedule type.
\nRealtime EFT (EFTRTC) only allows for for Master schedule type.
\n","_postman_id":"623cd2f8-8f1a-4265-a47a-ead51da321cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Get (Read)","item":[{"name":"Get Payment Beneficiary","id":"9a7ce3e5-166f-46ac-b10f-ef0d75210eb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments/008214162114095080111250214051009153035005245165","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments","008214162114095080111250214051009153035005245165"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"97409bc7-98dd-4f2d-8c8b-d9c996d0d569","name":"Get Payment Beneficiary - Success","originalRequest":{"method":"GET","header":[],"url":"{{ApiUrl}}/api/beneficiaries/payments/{{id}}"},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1366-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1366-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 07:25:13 GMT"},{"key":"Content-Length","value":"533"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"123456789\",\n \"bankName\": \"ABSA\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 1,\n \"amount\": 125.25,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-ONCE-OFF\",\n \"endDate\": null,\n \"id\": \"231098179245144012201000129054062228204082179131\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Joe Black\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test ABCD-ONCE-OFF\",\n \"scheduleType\": 2,\n \"serviceCode\": \"PPREFTSAL\",\n \"startDate\": null,\n \"tokenHash\": \"463A07958C151D8335E932C82E208185BB1BAC5E\"\n}"}],"_postman_id":"9a7ce3e5-166f-46ac-b10f-ef0d75210eb8"}],"id":"e18d71c2-003f-471f-847e-50d0e8147619","description":"Get single beneficiary using they id
\n","_postman_id":"e18d71c2-003f-471f-847e-50d0e8147619","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Update","item":[{"name":"Update Master Payment Beneficiary","id":"b016e942-56e1-4cf2-b3fe-fb854a605687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"accountNumber\": 123456789,\n\t\"amount\": null,\n\t\"branchCode\": 632005,\n\t\"clientCode\": \"PSZER001\",\n\t\"clientName\": \"Zero Zero One\",\n\t\"customerCode\": \"ABCD-MAST\",\n\t\"id\": \"008214162114095080111250214051009153035005245165\",\n\t\"isActive\": true,\n\t\"name\": \"Judah Rice\",\n\t\"reference\": \"8b9c8b0d-089e-4187-8378-3e8b3ec5943d\",\n\t\"scheduleType\": 0,\n\t\"serviceCode\": \"PPREFTCRE\",\n\t\"bankName\": \"FNB South Africa\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments","description":"Supported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nUpdate payment beneficiaries, this using the Id to find an exsisting beneficiary and update the related fields as per request
\n","_postman_id":"59f91bd9-7da8-4ec2-a553-ec8b7941c85e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Delete","item":[{"name":"Delete Payment Beneficiary","id":"d2ac6770-1bf1-4642-a5d8-32840f11aa12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments/delete?entityKey=008214162114095080111250214051009153035005245165","description":"Remove payment beneficiary.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","payments","delete"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"entityKey","value":"008214162114095080111250214051009153035005245165"}],"variable":[]}},"response":[{"id":"7d041de7-6a27-48ef-b781-5dd9a3cad3aa","name":"Delete Payment Beneficiary - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments/delete?entityKey=008214162114095080111250214051009153035005245165","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments","delete"],"query":[{"key":"entityKey","value":"008214162114095080111250214051009153035005245165"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 13:56:02 GMT"},{"key":"Content-Length","value":"4"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"89ff99b3-fbf1-4de0-823b-f76268df986d","name":"Delete Payment Beneficiary - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/payments/delete?entityKey=148031081148064107020182080024026008152185076112","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","payments","delete"],"query":[{"key":"entityKey","value":"148031081148064107020182080024026008152185076112"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 27 Oct 2023 10:11:41 GMT"},{"key":"Content-Length","value":"40"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Not a valid beneficiary id\"\n}"}],"_postman_id":"d2ac6770-1bf1-4642-a5d8-32840f11aa12"}],"id":"9f520c2d-ff26-43f3-a323-3c453866958e","description":"Removes payment beneficiaries using the Id to find an exsisting beneficiary and removes it.
\nNote: The response to this request is a Boolean True for successful deletion and false / blank otherwise.
\n","_postman_id":"9f520c2d-ff26-43f3-a323-3c453866958e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}}],"id":"bb247b4e-26e0-481f-b8e6-4635d8ba88fa","description":"Managing beneficiaries using the four basic functions Create, Read, Update, and Delete (CRUD).
\nThe request structure consists of the following elements to be passed in a JSON object:
\nFor tokenised payments: TokenHash
\nFor reference to the internal beneficiary: Id
\nThe response will be a JSON object with the following properties:
\nThis endpoint can be used to obtain a list of current collection beneficiaries. Collections are broken down into 2 services namely debit orders (DEBORD) and naedo (NAEDO). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","collections"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"DEBORD"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"8c17d157-a7b3-471c-b02d-a57d67af16a4","name":"Get List of Debit Order Beneficiaries - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections?client=PSZER001&service=DEBORD&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"DEBORD"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 14:17:28 GMT"},{"key":"Content-Length","value":"8426"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": \"2\",\n \"pageCount\": 2,\n \"pageNumber\": 1,\n \"pages\": [\n {\n \"cssClass\": \"currentPage\",\n \"pageNumber\": \"1\",\n \"pageUrl\": null\n },\n {\n \"cssClass\": \"\",\n \"pageNumber\": \"2\",\n \"pageUrl\": null\n }\n ],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": true,\n \"showPreviousPage\": false,\n \"totalResults\": 19\n },\n \"results\": [\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-MAST\",\n \"endDate\": null,\n \"id\": \"113122182020247076249253179244155204180122248014\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Benje Mouton\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 0,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"16FEEF5123A7982AE34926E26F47DE8D2F7EAAB9\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-MAST\",\n \"endDate\": null,\n \"id\": \"096039099080045140237126074078162133237050074212\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Benje Mouton\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 0,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"DC3DAE4E85A298CEED8FACD0E87E07DB33FBAAEA\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-MAST\",\n \"endDate\": null,\n \"id\": \"220125164028234009041044051003028125113103090079\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Benje Mouton\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 0,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"25DBF8E89603DE00F0745AD91195FB89A11A5A73\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-MAST\",\n \"endDate\": null,\n \"id\": \"099138144007183222156222038002178009070255039246\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Benje Mouton\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 0,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"DAD750E9A76FDD6C31C34C0008196C17771ECD56\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 28,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA3\",\n \"endDate\": null,\n \"id\": \"053188196027068005012030214189131206230096176161\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 3\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 2\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"DEBAF7E51100EA278B9C868CFC0E06\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 5,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA3\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"228158141129065034018165242000097063013248185013\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 3\",\n \"recurringPeriod\": 1,\n \"reference\": \"Example 3\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"5A69120AA62C042EACCF7140B48461\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 5,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 2500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA3\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"028155075074028204121176198166153092083024224022\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 3\",\n \"recurringPeriod\": 1,\n \"reference\": \"Example 3\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"18A77DB828C078905C8B21EFD06A3B7728C0A507\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 5,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 2500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA3\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"184242115112049014091077104171136171204231058076\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 3\",\n \"recurringPeriod\": 1,\n \"reference\": \"Example 3\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"017A90CB294B935173769637127DDCE132CA8096\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 15,\n \"debitMonth\": 12,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA5\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"074221114220143016015254186015238076149067039216\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 5\",\n \"recurringPeriod\": 3,\n \"reference\": \"Example 5\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"44D3B9F013984857B151C29C3D1205265A1FFFC2\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 15,\n \"debitMonth\": 12,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA5\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"187108030174233110052209081092172185223068081143\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 5\",\n \"recurringPeriod\": 3,\n \"reference\": \"Example 5\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"D806968C1EDC4160B112E6AD113CA5CF75CC5605\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 15,\n \"debitMonth\": 12,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA5\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"123035058079122090004099070049138012123195015032\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 5\",\n \"recurringPeriod\": 3,\n \"reference\": \"Example 5\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"CECC1776FA095CAF7D21F14D94E11F3E3E09CFAA\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 15,\n \"debitMonth\": 12,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 5,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA5\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"096186031214039057076125009244018181179093196230\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 5\",\n \"recurringPeriod\": 3,\n \"reference\": \"Example 5\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"377089C6C48CB38ACB4134F50D84004D3657CB03\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 15,\n \"debitMonth\": 12,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA5\",\n \"endDate\": \"2014-03-15T00:00:00\",\n \"id\": \"111195006222250088250069175099068023117111020227\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 5\",\n \"recurringPeriod\": 3,\n \"reference\": \"Example 5\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2013-03-15T00:00:00\",\n \"tokenHash\": \"917F779F579D162A8A533686D2C59E\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": null,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": null,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-MAST\",\n \"endDate\": null,\n \"id\": \"071084110022121152238047000047155056188107067200\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Name\",\n \"recurringPeriod\": 0,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 0,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": null,\n \"tokenHash\": \"E10293124648B8A6EC3E2777B738D6B1BB1F528F\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": 31,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 99.99,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-RECUR\",\n \"endDate\": \"2021-01-01T00:00:00\",\n \"id\": \"088080022098238076168090048114134073026192040072\",\n \"installments\": 12,\n \"isActive\": true,\n \"name\": \"Example Name\",\n \"recurringPeriod\": 2,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 1,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2020-01-01T00:00:00\",\n \"tokenHash\": \"B7CC6E9B8FB6F33C5F0AE193D9B0414830FA7031\"\n }\n ]\n}"},{"id":"9107f5af-d124-4c94-a839-33df5e7ea0d6","name":"Get List of Debit Order Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections?client=PSZER001&service=DEBORD&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"DEBORD"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 14:15:54 GMT"},{"key":"Content-Length","value":"40"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid client code Zer001\"\n}"}],"_postman_id":"2d46fcb6-d7c3-4c87-b1e5-bc3facd8c186"},{"name":"Get List of Naedo Beneficiaries","id":"2c2316e3-eec5-47b7-b58d-d84c01445bae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections?client=PSZER001&service=NAEDO&query=&page=1&pageSize=15","description":"This endpoint can be used to obtain a list of current collection beneficiaries. Collections are broken down into 2 services namely debit orders (DEBORD) and naedo (NAEDO). The service code along with the full client code parameter is required to make a successful call.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","collections"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"NAEDO"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}],"variable":[]}},"response":[{"id":"3d1153e7-ea4c-44d3-9c83-eff5f833532b","name":"Get List of Naedo Beneficiaries - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections?client=PSZER001&service=NAEDO&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":"NAEDO"},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 14:16:40 GMT"},{"key":"Content-Length","value":"3919"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": null,\n \"pageCount\": 1,\n \"pageNumber\": 1,\n \"pages\": [],\n \"pageSize\": 15,\n \"previousPageNumber\": null,\n \"showNextPage\": false,\n \"showPreviousPage\": false,\n \"totalResults\": 7\n },\n \"results\": [\n {\n \"accountNumber\": \"60528463700\",\n \"bankName\": \"\",\n \"branchCode\": \"250655\",\n \"debitDay\": 25,\n \"debitMonth\": null,\n \"trackingDays\": 6,\n \"accountType\": 0,\n \"amount\": 5,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"AVE 003\",\n \"endDate\": null,\n \"id\": \"245102142216190207050225177208185249209112133029\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Bruce Banner\",\n \"recurringPeriod\": 2,\n \"reference\": \"Aaq001\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": null,\n \"tokenHash\": \"745C901066F90F933916E16DF3B30B16AA278374\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 18,\n \"debitMonth\": null,\n \"trackingDays\": 7,\n \"accountType\": 0,\n \"amount\": 45,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA4\",\n \"endDate\": \"2017-07-18T00:00:00\",\n \"id\": \"171108006250191110100007167140040111162163223105\",\n \"installments\": 5,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 4\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 2\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2017-03-14T00:00:00\",\n \"tokenHash\": \"1636BCC4FA2846D89EEE1DF82CDCAE\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 1,\n \"debitMonth\": null,\n \"trackingDays\": 16,\n \"accountType\": 0,\n \"amount\": 500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA4\",\n \"endDate\": \"2013-08-01T00:00:00\",\n \"id\": \"070105162189233053124112158158180238073247161121\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 4\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 4\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2013-02-01T00:00:00\",\n \"tokenHash\": \"77B208F175CD481DBBE987F1A18CFD\"\n },\n {\n \"accountNumber\": \"123456789\",\n \"bankName\": \"\",\n \"branchCode\": \"632005\",\n \"debitDay\": 1,\n \"debitMonth\": null,\n \"trackingDays\": 7,\n \"accountType\": 0,\n \"amount\": 2500,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"EXA4\",\n \"endDate\": \"2013-08-01T00:00:00\",\n \"id\": \"229080105241154158081069041181154124161109123039\",\n \"installments\": 6,\n \"isActive\": true,\n \"name\": \"Example Beneficiary 4\",\n \"recurringPeriod\": 2,\n \"reference\": \"Example 4\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2013-02-01T00:00:00\",\n \"tokenHash\": \"55A3AA6DD8E90C931EE16F6C4BA95656682CBB83\"\n },\n {\n \"accountNumber\": \"1358517116\",\n \"bankName\": \"\",\n \"branchCode\": \"470010\",\n \"debitDay\": 9,\n \"debitMonth\": null,\n \"trackingDays\": 2,\n \"accountType\": 2,\n \"amount\": 0.01,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"Kv01\",\n \"endDate\": null,\n \"id\": \"198072005009117055236109163229015114058215169040\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Karin Joubert\",\n \"recurringPeriod\": 2,\n \"reference\": \"joe's school fees\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2020-08-02T00:00:00\",\n \"tokenHash\": \"9785B77A6741264025CAB639605DAB8154E5E8DF\"\n },\n {\n \"accountNumber\": \"62261470399\",\n \"bankName\": \"\",\n \"branchCode\": \"250655\",\n \"debitDay\": 8,\n \"debitMonth\": null,\n \"trackingDays\": 1,\n \"accountType\": 0,\n \"amount\": 50,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"1000000071\",\n \"endDate\": \"2014-04-08T00:00:00\",\n \"id\": \"186011155241217118179126099125140205158172134114\",\n \"installments\": 1,\n \"isActive\": true,\n \"name\": \"Patty Mukhari\",\n \"recurringPeriod\": 2,\n \"reference\": \"1000000071\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2014-04-08T00:00:00\",\n \"tokenHash\": \"153BEADF412998EAA3C7E96567720C\"\n },\n {\n \"accountNumber\": \"1134876000\",\n \"bankName\": \"\",\n \"branchCode\": \"198765\",\n \"debitDay\": 30,\n \"debitMonth\": null,\n \"trackingDays\": 0,\n \"accountType\": 0,\n \"amount\": 15,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"AVE 004\",\n \"endDate\": \"2021-09-15T00:00:00\",\n \"id\": \"036150231228011255222057005025076186087045138046\",\n \"installments\": null,\n \"isActive\": true,\n \"name\": \"Steve Rogers\",\n \"recurringPeriod\": 2,\n \"reference\": \"Aaq002\",\n \"scheduleType\": 1,\n \"serviceCode\": \"NAEDO\",\n \"startDate\": \"2020-07-20T00:00:00\",\n \"tokenHash\": \"F52FF2D6A5DF41097134AC030AE1D2C5116DEDDB\"\n }\n ]\n}"},{"id":"9861f3d4-a51b-4407-a2f2-8080273737a6","name":"Get List of Naedo Beneficiaries - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections?client=PSZER001&service=&query=&page=1&pageSize=15","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections"],"query":[{"key":"client","value":"PSZER001"},{"key":"service","value":""},{"key":"query","value":""},{"key":"page","value":"1"},{"key":"pageSize","value":"15"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Thu, 26 Oct 2023 14:18:05 GMT"},{"key":"Content-Length","value":"34"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Invalid service code\"\n}"}],"_postman_id":"2c2316e3-eec5-47b7-b58d-d84c01445bae"}],"id":"600b320c-4751-478e-a6d4-98979a7e3d3b","description":"These endpoints can be used to obtain a list of collections beneficiaries. Collections are broken down into three services, namely;
\nTo make a successful call, the service code and the full client code parameter are required.
\nExample
\nThe request structure consists of 5 keys to be passed in as parameters:
\nThe response will be a JSON object with the following properties:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nCreate beneficiaries based on schedule type
\n","_postman_id":"f3b1357e-8cf0-4ec9-8ce8-9acb5f495a08","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Get (Read)","item":[{"name":"Get Collection Beneficiary","id":"233eba96-508d-41c7-a437-5ad2ed55797d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections/008214162114095080111250214051009153035005245165","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","collections","008214162114095080111250214051009153035005245165"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"46aa274f-b189-4688-ada3-cb4cafff360e","name":"Get Collection Beneficiary - Success","originalRequest":{"method":"GET","header":[],"url":"{{ApiUrl}}/api/beneficiaries/collections/{{id}}"},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 27 Oct 2023 10:26:16 GMT"},{"key":"Content-Length","value":"567"}],"cookie":[],"responseTime":null,"body":"{\n \"accountNumber\": \"123456789\",\n \"bankName\": \"FNB South Africa\",\n \"branchCode\": \"632005\",\n \"debitDay\": 31,\n \"debitMonth\": null,\n \"trackingDays\": null,\n \"accountType\": 0,\n \"amount\": 99.99,\n \"clientCode\": \"PSZer001\",\n \"clientName\": \"Zero Zero One\",\n \"customerCode\": \"ABCD-RECUR\",\n \"endDate\": \"2021-01-01T00:00:00\",\n \"id\": \"094125165077140113128234079090239018127164252246\",\n \"installments\": 12,\n \"isActive\": true,\n \"name\": \"Benje Mouton\",\n \"recurringPeriod\": 2,\n \"reference\": \"Test Reference\",\n \"scheduleType\": 2,\n \"serviceCode\": \"DEBORD\",\n \"startDate\": \"2020-01-01T00:00:00\",\n \"tokenHash\": \"F1B242ADDFCA34C878F02A59064402894A2CCAC0\"\n}"},{"id":"4bbba713-db8a-4b47-9a0c-5fd113d17da1","name":"Get Collection Beneficiary - Error","originalRequest":{"method":"GET","header":[],"url":"{{ApiUrl}}/api/beneficiaries/collections/{{id}}"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 27 Oct 2023 10:28:21 GMT"},{"key":"Content-Length","value":"61"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Authorization has been denied for this request.\"\n}"}],"_postman_id":"233eba96-508d-41c7-a437-5ad2ed55797d"}],"id":"8577e92c-7958-4243-ac4e-9bfd22545a5b","description":"Get single collections beneficiary using they id
\n","_postman_id":"8577e92c-7958-4243-ac4e-9bfd22545a5b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Update","item":[{"name":"Update Master Collection Beneficiary","id":"ea20241b-acfb-4b06-a000-9fc37599f2eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"accountNumber\": 123456789,\n\t\"amount\": null,\n\t\"branchCode\": 632005,\n\t\"clientCode\": \"PSZER001\",\n\t\"clientName\": \"Zero Zero One\",\n\t\"customerCode\": \"CUSTOMER1234\",\n\t\"id\": \"008214162114095080111250214051009153035005245165\",\n\t\"isActive\": true,\n\t\"name\": \"Furman Franecki\",\n\t\"reference\": \"96605217-a6e0-4458-8dcc-1b8396df8ace\",\n\t\"scheduleType\": 0,\n\t\"serviceCode\": \"DEBORD\",\n\t\"bankName\": \"FNB South Africa\"\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections","description":"Supported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nSupported Account Types:
\nSupported Recurring Periods:
\nSupported Schedule Types:
\nUpdate collections beneficiary, this using the Id to find an exsisting beneficiary and update the related fields as per request
\n","_postman_id":"6e01f6c4-98a6-4532-8ba4-a3766106c23e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Delete","item":[{"name":"Delete Collection Beneficiary","id":"e8dcfbdf-7de2-46cf-8c19-bbdaef9853d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections/delete?entityKey=008214162114095080111250214051009153035005245165","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["api","beneficiaries","collections","delete"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"key":"entityKey","value":"008214162114095080111250214051009153035005245165"}],"variable":[]}},"response":[{"id":"f7d719d6-201a-4086-8dbf-0bf23afd7538","name":"Delete Collection Beneficiary - Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections/delete?entityKey=008214162114095080111250214051009153035005245165","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections","delete"],"query":[{"key":"entityKey","value":"008214162114095080111250214051009153035005245165"}]}},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 27 Oct 2023 10:38:03 GMT"},{"key":"Content-Length","value":"4"}],"cookie":[],"responseTime":null,"body":"true"},{"id":"1eb04331-d7db-4338-a791-f00fc79884a6","name":"Delete Collection Beneficiary - Error","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-api.paysoft.co.za/api/beneficiaries/collections/delete?entityKey=023071157250182189132149098015237044016180018197","host":["https://sandbox-api.paysoft.co.za"],"path":["api","beneficiaries","collections","delete"],"query":[{"key":"entityKey","value":"023071157250182189132149098015237044016180018197"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"WWW-Authenticate","value":"Bearer"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1370-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 27 Oct 2023 10:37:02 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"e8dcfbdf-7de2-46cf-8c19-bbdaef9853d9"}],"id":"d98e21d4-b000-4cc5-948f-69488e147827","description":"Removes collection beneficiary using the Id to find an exsisting beneficiary and removes it.
\nNote: The response to this request is a Boolean True for successful deletion and false / blank otherwise.
\n","_postman_id":"d98e21d4-b000-4cc5-948f-69488e147827","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}}],"id":"385fed15-78ef-41ba-b389-d1d183c2fddf","description":"Managing collection beneficiaries using the four basic functions Create, Read, Update, and Delete (CRUD).
\nThe request structure consists of the following elements to be passed in a JSON object:
\nThe response will be a JSON object with the following properties:
\nReturns 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.
\nCollection Occurences
\nOnce-off
\nRecurring
\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.
\nAvailable Collection Days
\nWeekly
\n1 = \"01 - Monday\"
\n2 = \"02 - Tuesday\"
\n3 = \"03 - Wednesday\"
\n4 = \"04 - Thursday\"
\n5 = \"05 - Friday\"
\n6 = \"06 - Saturday\"
\n7 = \"07 - Sunday\"
\nFort Nightly
\n1 = \"01 - Monday (1st week)\"
\n2 = \"02 - Tuesday (1st week)\"
\n3 = \"03 - Wednesday (1st week)\"
\n4 = \"04 - Thursday (1st week)\"
\n5 = \"05 - Friday (1st week)\"
\n6 = \"06 - Saturday (1st week)\"
\n7 = \"07 - Sunday (1st week)\"
\n8 = \"08 - Monday (2nd week)\"
\n9 = \"09 - Tuesday (2nd week)\"
\n10 = \"10 - Wednesday (2nd week)\"
\n11 = \"11 - Thursday (2nd week)\"
\n12 = \"12 - Friday (2nd week)\"
\n13 = \"13 - Saturday (2nd week)\"
\n14 = \"14 - Sunday (2nd week)\"
\nMonthly
\n1 to 30 = \"Days 1 to 30\"
\n99 = \"99 - Last day\"
\nQuarterly
\n1 to 30 = \"Days 1 to 30\"
\n99 = \"99 - Last day\"
\nBi-annually
\n1 to 30 = \"Days 1 to 30\"
\n99 = \"99 - Last day\"
\nAnnually
\n1 to 30 = \"Days 1 to 30\"
\n99 = \"99 - Last day\"
\nAd Hoc
\n1 = \"01 - Last Monday\"
\n2 = \"02 - Last Tuesday\"
\n3 = \"03 - Last Wednesday\"
\n4 = \"04 - Last Thursday\"
\n5 = \"05 - Last Friday\"
\n6 = \"06 - Last Saturday\"
\n7 = \"07 - First Monday\"
\n8 = \"08 - First Tuesday\"
\n9 = \"09 - First Wednesday\"
\n10 = \"10 - First Thursday\"
\n11 = \"11 - First Friday\"
\n12 = \"12 - First Saturday\"
\n14 = \"14 - 2nd Last day\"
\n99 = \"99 - Last day\"
\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 register statuses. These are statuses refering to the mandate register record which is the master record of the mandate.
\nMandate Register Statuses
\n0 - Pending
\n1 - No response
\n2 - Not authenticated
\n3 - Authenticated
\n4 - Cancelled
\n5 - Suspended
\nReturns a list of possible mandate transaction statuses. These are statuses refering to the transaction statuses of the mandate for any in progress transactions against a mandate.
\nMandate Transaction Statuses
\n0 - None
\n1 - Saved
\n2 - Pending
\n3 - Accepted
\n4 - Rejected
\n5 - No response
\n6 - Provider error
\n7 - System error
\n8 - Queued
\n9 - Cancelled
\n10 - Suspended
\n11 - Authenticated
\n12 - Not authenticated
\nReturns a list of debit value types.
\nReturns a list of id types.
\nId Types
\nId document
\nPassport
\nTemporary residence id
\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","_postman_id":"06e9a343-0cac-4dbe-a523-d5983766dbf1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Read Mandate Data","item":[{"name":"Search Mandates","id":"9a914310-9bbe-4464-a366-559d5236ae76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/mandates?contractReference=CONTRACT1234","description":"This method is used for searching mandates which have already been submitted. Result sets are restricted to user/client access permissions.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates"],"host":["https://sandbox-api.paysoft.co.za"],"query":[{"disabled":true,"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":""},{"disabled":true,"description":{"content":"A comma seperated list of mandate status Ids
\n","type":"text/plain"},"key":"statuses","value":""},{"disabled":true,"description":{"content":"A comma seperated list of debit value type Ids
\n","type":"text/plain"},"key":"types","value":""},{"disabled":true,"description":{"content":"A comma seperated list of collection frequency Ids
\n","type":"text/plain"},"key":"collectionFrequencies","value":""},{"disabled":true,"description":{"content":"The debtor Id number
\n","type":"text/plain"},"key":"debtorIdNumber","value":""},{"disabled":true,"description":{"content":"The debtor bank account number
\n","type":"text/plain"},"key":"debtorAccountNumber","value":""},{"disabled":true,"description":{"content":"The start date of the period in which mandates being searched for were created
\n","type":"text/plain"},"key":"createdStartDate","value":""},{"disabled":true,"description":{"content":"The end date of the period in which mandates being searched for were created
\n","type":"text/plain"},"key":"createdEndDate","value":""},{"disabled":true,"description":{"content":"The debtor's first, last or full name
\n","type":"text/plain"},"key":"debtorName","value":""},{"disabled":true,"description":{"content":"The mandate bank reference number of a specific mandate.
\n","type":"text/plain"},"key":"mandateReferenceNumber","value":"21001600013160638339148015761559"},{"description":{"content":"The mandate contract reference number.
\n","type":"text/plain"},"key":"contractReference","value":"CONTRACT1234"}],"variable":[]}},"response":[{"id":"97147f0d-bad2-4807-bcba-431868a5458c","name":"200 OK - Successful Search Mandates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":{"raw":"https://sandbox-api.paysoft.co.za/mandates?clients=ZER001&statuses=1&types=2&collectionFrequencies=1&debtorIdNumber=8808215437086&debtorAccountNumber=123456789&createdStartDate=&createdEndDate=","host":["https://sandbox-api.paysoft.co.za"],"path":["mandates"],"query":[{"key":"clients","value":"ZER001"},{"key":"statuses","value":"1"},{"key":"types","value":"2"},{"key":"collectionFrequencies","value":"1"},{"key":"debtorIdNumber","value":"8808215437086"},{"key":"debtorAccountNumber","value":"123456789"},{"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\": \"PaysoftTest2\",\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":"9a914310-9bbe-4464-a366-559d5236ae76"},{"name":"Get Mandate","event":[{"listen":"test","script":{"id":"2f03c7c6-a0fa-46f9-8b71-5f83cb4fe8e1","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateReference\", data.mandateReference);","pm.variables.get(\"mandateReference\");",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"d20132ec-d373-4654-bf65-af5e63956061","exec":[""],"type":"text/javascript"}}],"id":"6edf83f7-3051-40bc-8bc3-af650acde9b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/mandates/251122116115144108230247160168247244060038022090","description":"This method allows integrators to fetch a single mandate using the mandate ID supplied in the search mandates request.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","251122116115144108230247160168247244060038022090"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"b400d712-0a27-4cd5-9fd2-608e237c2c69","name":"Get Mandate - Success","originalRequest":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/mandates/251122116115144108230247160168247244060038022090"},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 03 Nov 2023 11:05:30 GMT"},{"key":"Content-Length","value":"1556"}],"cookie":[],"responseTime":null,"body":"{\n \"authenticationDate\": null,\n \"canBeAmendedOrCancelled\": false,\n \"canBeDeleted\": true,\n \"canBeResubmitted\": true,\n \"canBeResubmittedAsRms\": false,\n \"cancellationReason\": null,\n \"changedDate\": \"2023-11-03T13:04:16.04\",\n \"client\": {\n \"clientCode\": \"PSACPT01\",\n \"clientName\": \"Back Office Simulator (Accepted)\"\n },\n \"collection\": {\n \"adjustmentAmount\": null,\n \"adjustmentCategory\": \"Never\",\n \"adjustmentCategoryId\": 1,\n \"adjustmentRate\": null,\n \"collectionDay\": 1,\n \"dateAdjustmentAllowed\": false,\n \"entryClass\": \"Insurance premium\",\n \"entryClassId\": 1,\n \"finalDate\": null,\n \"frequency\": \"Monthly\",\n \"frequencyId\": 3,\n \"initialAmount\": 0,\n \"initialDate\": null,\n \"instalmentAmount\": 120.5,\n \"latestBatchNumber\": null,\n \"latestStatus\": null,\n \"latestStatusDescription\": null,\n \"latestStatusId\": 0,\n \"maxAmount\": 150,\n \"nextDate\": null,\n \"occurrence\": \"Once off\",\n \"occurrenceId\": 1,\n \"trackingAllowed\": false,\n \"type\": \"Variable\",\n \"typeId\": 2\n },\n \"contractReference\": \"CONTRACT1234\",\n \"creationDate\": \"2023-11-03T13:04:16.04\",\n \"customerCode\": \"CUSTOMER1234\",\n \"debtor\": {\n \"accountNumber\": \"123456789\",\n \"accountType\": \"Current/Cheque\",\n \"accountTypeId\": 1,\n \"branchCode\": \"632005\",\n \"phoneNumber\": \"+27836789551\",\n \"idType\": \"Id document\",\n \"idTypeId\": 1,\n \"emailAddress\": \"Lonny.Gutkowski@yahoo.com\",\n \"idNumber\": \"8808215437086\",\n \"name\": \"Retha Hudson\"\n },\n \"initiationDate\": \"2023-11-03T00:00:00\",\n \"isMigratedNaedo\": false,\n \"isRegisteredMandate\": false,\n \"latestStatus\": \"Pending\",\n \"latestStatusDescription\": \"Pending\",\n \"latestStatusId\": 2,\n \"mandateReference\": \"\",\n \"mandateRegisterId\": \"215178204146242091020221082019097093199176008113\",\n \"releaseDate\": null,\n \"status\": \"Pending\",\n \"statusDescription\": \"Pending\",\n \"statusId\": 0\n}"},{"id":"8ea857b3-407e-438b-90c0-bed8f3291342","name":"200 OK - Successful Get Mandate","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{baseUrl}}/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":"6edf83f7-3051-40bc-8bc3-af650acde9b5"},{"name":"Get Mandate History","id":"988a5d1e-531c-43dd-830f-ce8a3b46bc9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/mandates/history/251122116115144108230247160168247244060038022090","description":"This method allows integrators to return the change history related to a mandate.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","history","251122116115144108230247160168247244060038022090"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"7bafba7e-a968-4ed5-84fa-51b913be192e","name":"Get Mandate History - Success","originalRequest":{"method":"GET","header":[],"url":"https://sandbox-api.paysoft.co.za/mandates/history/251122116115144108230247160168247244060038022090"},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 03 Nov 2023 11:06:16 GMT"},{"key":"Content-Length","value":"1054"}],"cookie":[],"responseTime":null,"body":"{\n \"pageData\": {\n \"nextPageNumber\": null,\n \"pageCount\": 1,\n \"pageNumber\": 0,\n \"pages\": [],\n \"pageSize\": 20,\n \"previousPageNumber\": null,\n \"showNextPage\": false,\n \"showPreviousPage\": false,\n \"totalResults\": 1\n },\n \"results\": [\n {\n \"aggregation\": \"Transaction type 2\",\n \"amendmentReason\": \"\",\n \"batchDescription\": \"\",\n \"batchNumber\": \"3000364\",\n \"canBeResubmitted\": true,\n \"cancellationReason\": \"\",\n \"clientCode\": \"ACPT01\",\n \"clientName\": \"Back Office Simulator (Accepted)\",\n \"contractReference\": \"CONTRACT1234\",\n \"customerCode\": \"CUSTOMER1234\",\n \"debtorIdNumber\": \"8808215437086\",\n \"debtorName\": \"Retha Hudson\",\n \"mandateBatchId\": \"086132254157025232107106035038207087138161220091\",\n \"mandateRegisterId\": \"215178204146242091020221082019097093199176008113\",\n \"mandateStatus\": \"Pending\",\n \"mandateStatusDate\": \"2023-11-03T13:04:19.093\",\n \"mandateStatusDescription\": \"Pending\",\n \"mandateStatusId\": 2,\n \"mandateTransactionId\": \"013154120215227191102253190106141156239244153029\",\n \"mandateType\": \"Initiation\",\n \"mandateTypeId\": 1,\n \"message\": \"Initiation\",\n \"processDate\": \"2023-11-03T13:04:18.577\",\n \"transactionType\": \"TT2 - batch delayed authorisation - 48 hours\"\n }\n ]\n}"},{"id":"09ac5e92-f9bc-4199-922b-ef08a0488bc0","name":"200 OK - Successful Get Mandate History","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"{{baseUrl}}/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":"988a5d1e-531c-43dd-830f-ce8a3b46bc9c"}],"id":"ad2e3857-12e7-4020-8b78-9e79419c4c34","_postman_id":"ad2e3857-12e7-4020-8b78-9e79419c4c34","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Save/Update/Delete Mandates","item":[{"name":"Initiate Mandate","event":[{"listen":"test","script":{"id":"c632f415-5856-4557-9101-a2839a80099b","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"ab0a32d4-a348-4384-9f33-12c0a2f19856","exec":[""],"type":"text/javascript"}}],"id":"87f23111-19d3-40ae-9fe2-20be5a4d0ce1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"callbackUrl\": \"\",\n\t\"clientCode\": \"PSZER001\",\n\t\"transactionType\": 1,\n\t\"contractReference\": \"CONTRACT1\",\n\t\"customerCode\": \"CUSTOMER1234\",\n\t\"entryClassId\": 1,\n\t\"releaseDate\": \"\",\n\t\"debtor\": {\n\t\t\"accountNumber\": \"123456789\",\n\t\t\"accountTypeId\": \"1\",\n\t\t\"branchCode\": \"632005\",\n\t\t\"emailAddress\": \"Ara_Grady@gmail.com\",\n\t\t\"idNumber\": \"8808215437086\",\n\t\t\"idTypeId\": \"1\",\n\t\t\"name\": \"Fabian Reichel\",\n\t\t\"phoneNumber\": \"+27836789551\"\n\t},\n\t\"collection\": {\n\t\t\"adjustmentAmount\": \"\",\n\t\t\"adjustmentCategoryId\": 1,\n\t\t\"adjustmentRate\": \"\",\n\t\t\"collectionDay\": \"01\",\n\t\t\"dateAdjustmentAllowed\": false,\n\t\t\"entryClassId\": 1,\n\t\t\"finalDate\": \"\",\n\t\t\"frequencyId\": 3,\n\t\t\"initialAmount\": 0,\n\t\t\"initialDate\": \"\",\n\t\t\"instalmentAmount\": 120.50,\n\t\t\"maxAmount\": 150,\n\t\t\"occurrenceId\": 1,\n\t\t\"trackingAllowed\": false,\n\t\t\"typeId\": 2\n\t}\n}"},"url":"https://sandbox-api.paysoft.co.za/mandates/initiate","description":"This method is used for initiating a new mandate.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","initiate"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"043c099b-36f9-4a43-8f2d-768d5325aabd","name":"Initiate Mandate - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"callbackUrl\": \"\",\n\t\"clientCode\": \"PSZER001\",\n\t\"transactionType\": 10,\n\t\"typeId\": 1,\n\t\"contractReference\": \"CONTRACT1\",\n\t\"customerCode\": \"CUSTOMER1234\",\n\t\"entryClassId\": 1,\n\t\"releaseDate\": \"\",\n\t\"debtor\": {\n\t\t\"accountNumber\": \"123456789\",\n\t\t\"accountTypeId\": \"1\",\n\t\t\"branchCode\": \"632005\",\n\t\t\"emailAddress\": \"Prudence64@gmail.com\",\n\t\t\"idNumber\": \"8808215437086\",\n\t\t\"idTypeId\": \"1\",\n\t\t\"name\": \"Ezekiel Wintheiser\",\n\t\t\"phoneNumber\": \"+27836789551\"\n\t},\n\t\"collection\": {\n\t\t\"adjustmentAmount\": \"\",\n\t\t\"adjustmentCategoryId\": 1,\n\t\t\"adjustmentRate\": \"\",\n\t\t\"collectionDay\": \"01\",\n\t\t\"dateAdjustmentAllowed\": false,\n\t\t\"entryClassId\": 1,\n\t\t\"finalDate\": \"\",\n\t\t\"frequencyId\": 3,\n\t\t\"initialAmount\": 0,\n\t\t\"initialDate\": \"\",\n\t\t\"instalmentAmount\": 120.50,\n\t\t\"maxAmount\": 150,\n\t\t\"occurrenceId\": 1,\n\t\t\"trackingAllowed\": false,\n\t\t\"typeId\": 2\n\t}\n}"},"url":"https://sandbox-api.paysoft.co.za/mandates/initiate"},"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-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 03 Nov 2023 11:04:19 GMT"},{"key":"Content-Length","value":"337"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [],\n \"mandateReference\": null,\n \"mandateRegisterId\": \"215178204146242091020221082019097093199176008113\",\n \"mandateStatus\": \"None\",\n \"mandateStatusId\": 0,\n \"mandateTransactionId\": \"013154120215227191102253190106141156239244153029\",\n \"mandateTransactionReference\": null,\n \"message\": \"Success\",\n \"requestReference\": null,\n \"status\": \"Success\",\n \"statusId\": 10\n}"},{"id":"013844c7-cf5a-41d5-a490-072ccf722ccb","name":"200 OK - Successful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Kellen\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Jena_Macejkovic67@hotmail.com\"\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://sandbox.paysoft.co.za/api/mandates/initiate","host":["https://sandbox.paysoft.co.za/api"],"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}"},{"id":"ed2160ef-7310-4335-8e9c-d9dfaa42997c","name":"400 Bad Request - Unsuccessful (CDV Error) Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Anissa\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Era.Ankunding@gmail.com\"\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":"{{baseUrl}}/mandates/initiate","host":["{{baseUrl}}"],"path":["mandates","initiate"],"query":[{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"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":"9066446c-0112-4927-a689-459bb09c976d","name":"400 Bad Request - Unsuccessful Initiate Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Antonetta\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Tre.Labadie96@yahoo.com\"\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":"{{baseUrl}}/mandates/initiate","host":["{{baseUrl}}"],"path":["mandates","initiate"],"query":[{"key":"returnUrl","value":"%252fmandates%252f","disabled":true}]}},"_postman_previewlanguage":"json","header":null,"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":"87f23111-19d3-40ae-9fe2-20be5a4d0ce1"},{"name":"Amend Mandate","id":"3a3244e9-915c-46a0-b72e-09c08cf219d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"amendmentReasonId\": 1,\n\t\"callbackUrl\": \"\",\n\t\"clientCode\": \"PSZER001\",\n\t\"contractReference\": \"CONTRACT1\",\n\t\"customerCode\": \"CUSTOMER1234\",\n\t\"mandateReference\": \"21001600013160638339148015761559\",\n\t\"mandateRegisterId\": \"251122116115144108230247160168247244060038022090\",\n\t\"transactionType\": 1,\n\t\"debtor\": {\n\t\t\"accountNumber\": \"123456789\",\n\t\t\"accountTypeId\": \"1\",\n\t\t\"branchCode\": \"632005\",\n\t\t\"emailAddress\": \"Emiliano19@yahoo.com\",\n\t\t\"idNumber\": \"8808215437086\",\n\t\t\"idTypeId\": \"1\",\n\t\t\"name\": \"Brendon Hauck\",\n\t\t\"phoneNumber\": \"+27836789551\"\n\t},\n\t\"collection\": {\n\t\t\"adjustmentAmount\": \"\",\n\t\t\"adjustmentCategoryId\": 1,\n\t\t\"adjustmentRate\": \"\",\n\t\t\"collectionDay\": \"01\",\n\t\t\"dateAdjustmentAllowed\": false,\n\t\t\"entryClassId\": 1,\n\t\t\"finalDate\": \"\",\n\t\t\"frequencyId\": 3,\n\t\t\"initialAmount\": \"\",\n\t\t\"initialDate\": \"\",\n\t\t\"instalmentAmount\": 120.50,\n\t\t\"maxAmount\": 150,\n\t\t\"occurrenceId\": 1,\n\t\t\"trackingAllowed\": false,\n\t\t\"typeId\": 2\n\t}\n}"},"url":"https://sandbox-api.paysoft.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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","amend"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"821c41c8-00f3-4929-bc0c-f77e60ea1658","name":"Amend Mandate - Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"amendmentReasonId\": 1,\n\t\"callbackUrl\": \"\",\n\t\"clientCode\": \"PSZER001\",\n\t\"contractReference\": \"CONTRACT1\",\n\t\"customerCode\": \"CUSTOMER1234\",\n\t\"mandateReference\": \"21001600013160638339148015761559\",\n\t\"mandateRegisterId\": \"251122116115144108230247160168247244060038022090\",\n\t\"transactionType\": 1,\n\t\"debtor\": {\n\t\t\"accountNumber\": \"123456789\",\n\t\t\"accountTypeId\": \"1\",\n\t\t\"branchCode\": \"632005\",\n\t\t\"emailAddress\": \"Monserrate40@yahoo.com\",\n\t\t\"idNumber\": \"8808215437086\",\n\t\t\"idTypeId\": \"1\",\n\t\t\"name\": \"Arno Orn\",\n\t\t\"phoneNumber\": \"+27836789551\"\n\t},\n\t\"collection\": {\n\t\t\"adjustmentAmount\": \"\",\n\t\t\"adjustmentCategoryId\": 1,\n\t\t\"adjustmentRate\": \"\",\n\t\t\"collectionDay\": \"01\",\n\t\t\"dateAdjustmentAllowed\": false,\n\t\t\"entryClassId\": 1,\n\t\t\"finalDate\": \"\",\n\t\t\"frequencyId\": 3,\n\t\t\"initialAmount\": 0,\n\t\t\"initialDate\": \"\",\n\t\t\"instalmentAmount\": 120.50,\n\t\t\"maxAmount\": 150,\n\t\t\"occurrenceId\": 1,\n\t\t\"trackingAllowed\": false,\n\t\t\"typeId\": 2\n\t}\n}"},"url":"https://sandbox-api.paysoft.co.za/mandates/amend"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Environment","value":"Test"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Channel","value":"Public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"X-Paysoft-Deployment-Version","value":"0.0.1374-public"},{"key":"Strict-Transport-Security","value":"max-age=15768000"},{"key":"X-Powered-By","value":"ARR/3.0"},{"key":"Date","value":"Fri, 03 Nov 2023 12:01:39 GMT"},{"key":"Content-Length","value":"298"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"collection.collectionInitialAmount\": [\n \"The initial collection date is required if an initial collection amount is provided.\"\n ],\n \"collection.collectionInitialDate\": [\n \"The initial collection date is required if an initial collection amount is provided.\"\n ]\n },\n \"message\": \"The request is invalid.\"\n}"},{"id":"229cadfe-ec30-4e08-b9f3-0b15b0a18390","name":"200 OK - Successful Amend Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"Emelia\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Markus_Kreiger26@yahoo.com\"\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":"{{baseUrl}}/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":"c3369e53-de52-4b66-965b-8a785e5b9843","name":"500 Internal Server Error - Unsuccessful Amend Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"Gay\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Ahmad.Trantow@gmail.com\"\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":"{{baseUrl}}/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":"3a3244e9-915c-46a0-b72e-09c08cf219d2"},{"name":"Cancel Mandate","id":"f00e3b8e-0eac-44e4-b014-7524c682084f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"mandateRegisterId\":\"251122116115144108230247160168247244060038022090\",\n \"mandateReference\":\"21001600013160638339148015761559\",\n \"clientCode\": \"PSZER001\",\n\t\"cancellationReasonId\":\"1\",\n \"transactionType\": \"{{transactionType}}\"\n}\n"},"url":"https://sandbox-api.paysoft.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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","cancel"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"27c4f11f-9bc9-424e-89d4-29ce9305a4fa","name":"200 OK - Successful Cancel Mandate","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"mandateRegisterId\":\"251122116115144108230247160168247244060038022090\",\n \"mandateReference\":\"21001600013160638339148015761559\",\n \"clientCode\": \"PSZER001\",\n\t\"cancellationReasonId\":\"1\",\n \"transactionType\": \"{{transactionType}}\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.paysoft.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":null}],"_postman_id":"f00e3b8e-0eac-44e4-b014-7524c682084f"},{"name":"Import Mandates Batch","id":"289bb092-505b-487e-a873-f6a4c0c526d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\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 },\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 },\n\n ]\n}"},"url":"https://sandbox-api.paysoft.co.za/mandates/import","description":"Allows integrators to import a batch of mutliple mandates.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates","import"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"57167d51-337f-497a-8db7-b31e57f0877b","name":"200 OK - Successful Import Mandates Batch","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\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":"{{baseUrl}}/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}"},{"id":"492f92f2-50bf-4fcc-9492-357afc28b5cf","name":"200 OK - With Errors Import Mandates Batch","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\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":"{{baseUrl}}/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}"}],"_postman_id":"289bb092-505b-487e-a873-f6a4c0c526d4"},{"name":"Delete Mandate","id":"fefc39a2-2dab-459e-918b-12e63cc35241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"mandateRegisterId\":\"251122116115144108230247160168247244060038022090\"\n}\n\n "},"url":"https://sandbox-api.paysoft.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","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["mandates"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"b59179fa-007c-4233-8440-4a15a964e029","name":"200 OK - Successful Delete Mandate","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"mandateRegisterId\":\"251122116115144108230247160168247244060038022090\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.paysoft.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":null},{"id":"7f8bf78a-442b-4ef1-a023-e7b9b7a222ce","name":"400 Bad Request - Unsuccessful Delete Mandate","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"mandateRegisterId\":\"251122116115144108230247160168247244060038022090\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://sandbox-api.paysoft.co.za/mandates"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Bank initiated mandates cannot be deleted\"\n}"}],"_postman_id":"fefc39a2-2dab-459e-918b-12e63cc35241"}],"id":"44abb999-6524-494e-bdd7-a95004022948","_postman_id":"44abb999-6524-494e-bdd7-a95004022948","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Save/Update Mandate Test Cases","item":[{"name":"Initiate Mandate - Accepted","event":[{"listen":"test","script":{"id":"773e9d90-fa66-4741-a5af-d51a2a02ac66","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"e0480b41-2133-4da1-b97b-3cc000f44887","exec":[],"type":"text/javascript"}}],"id":"7c55c71f-2cac-4e4a-bd5e-a408b94e5940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"1\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Turner\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Holden.Welch63@hotmail.com\"\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://sandbox-api.paysoft.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://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"b1bbdb19-6ead-4da4-ba27-4e3a96f49e6d","name":"200 OK - Successful Initiate Mandate - Will be accepted by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Vivianne\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Xavier_Skiles@yahoo.com\"\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":"{{baseUrl}}/mandates/initiate","host":["{{baseUrl}}"],"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":"7c55c71f-2cac-4e4a-bd5e-a408b94e5940"},{"name":"Initiate Mandate - Rejected","event":[{"listen":"test","script":{"exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"mandateId\", data.mandateId);","pm.variables.get(\"mandateId\");",""],"type":"text/javascript","id":"ed25c1b8-f13a-429e-b658-5a9715d32984"}}],"id":"5e3a191e-0d27-498d-ab6b-d7d8d95ed050","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Jan\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Kara.Rohan@yahoo.com\"\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":"{{baseUrl}}/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":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"696e730c-d470-460b-a764-0d9b5a6db4e7","name":"200 OK - Successful Initiate Mandate - Will be rejected by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientCode\": \"ZER001\",\n \"transactionType\": \"2\",\n \"typeId\": \"1\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"entryClassId\": \"12\",\n \"releaseDate\": \"\",\n \"debtor\": {\n \"name\": \"Alford\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Carmelo.Block5@hotmail.com\"\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":"{{baseUrl}}/mandates/initiate","host":["{{baseUrl}}"],"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":"5e3a191e-0d27-498d-ab6b-d7d8d95ed050"},{"name":"Amend Mandate - Accepted","id":"7270ad10-78ad-4731-a8f8-bfe49f28ced2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"Dana\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Maudie.OKon79@gmail.com\"\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":"{{baseUrl}}/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":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"72f5b0bb-89c9-4607-aa22-b1067e1c6792","name":"200 OK - Successful Amend Mandate - Will be accepted by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"1\",\n \"debtor\": {\n \"name\": \"Nicolas\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Zita.Ondricka87@hotmail.com\"\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":"{{baseUrl}}/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":"7270ad10-78ad-4731-a8f8-bfe49f28ced2"},{"name":"Amend Mandate - Rejected","id":"082ac4b9-4aee-48db-ab33-3c1d629546f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"2\",\n \"debtor\": {\n \"name\": \"Delphine\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Terrence.Cronin@yahoo.com\"\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":"{{baseUrl}}/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":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"2d7172a4-061c-49e1-ad6b-a84cfdc46032","name":"200 OK - Successful Amend Mandate - Will be rejected by client","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n \"mandateId\": \"{{mandateId}}\",\n \"clientCode\": \"ZER001\",\n \"mandateReference\": \"21001600013160638339148015761559\",\n \"contractReference\": \"CONTRACT1\",\n \"customerCode\": \"CUSTOMER1234\",\n \"transactionType\": \"50\",\n \"amendmentReasonId\": \"2\",\n \"debtor\": {\n \"name\": \"Amiya\",\n \"accountNumber\": \"123456789\",\n \"branchCode\": \"632005\",\n \"accountType\": \"1\",\n \"identificationNumber\": \"8808215437086\",\n \"passportNumber\": \"\",\n \"contactNumberInternationalCode\": \"+27\",\n \"contactNumber\": \"+27836789551\",\n \"emailAddress\": \"Oceane76@gmail.com\"\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":"{{baseUrl}}/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":"082ac4b9-4aee-48db-ab33-3c1d629546f9"},{"name":"Cancel Mandate - Successful","id":"e01f6d74-a6f3-4802-8f60-9362b4f5abfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"id\":{{mandateId}},\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"{{baseUrl}}/mandates/cancel","description":"All cancelled mandates will be marked as cancelled
\n","urlObject":{"path":["mandates","cancel"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"32356dd7-b6b4-49cb-8e91-2c27c41cb767","name":"200 OK - Successful Cancel Mandate - Successfully Cancelled","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\n\t\"id\":{{mandateId}},\n\t\"cancellationReasonId\":\"1\"\n}\n\n "},"url":"{{baseUrl}}/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":null}],"_postman_id":"e01f6d74-a6f3-4802-8f60-9362b4f5abfa"}],"id":"924bf3af-347e-4147-b607-0fadcb1682cc","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","_postman_id":"924bf3af-347e-4147-b607-0fadcb1682cc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Sample Webhook","id":"29fa4a88-3050-4be9-8d15-68da6c35cf73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nOnce mandate results are received from the provider, this call-back url will be used to send the webhook containing the documented MandateResult object. It will be posted as a url encoded form encoded as multipart/form-data.
\nIt is important to note that should a call-back url be configured or provided, results will be relayed as received from the provider.
\nYou can also view the webhook history on the Paysoft portal if users were granted access to it. This will allow users to monitor failures or resend webhooks.
\nThe MandateResult section consists of the following elements:
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"3cc01a0d-0471-49eb-b659-2f718d234ac0","name":"Pending Authentication","originalRequest":{"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nThe mandates API allows one to manage mandates.
\n","_postman_id":"2565996b-1063-4eb5-8027-bc723b621acc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}},{"name":"Collections","item":[{"name":"Submit Collections","event":[{"listen":"test","script":{"id":"a367fc16-6dab-43ab-92db-f84fb0373864","exec":["var data = JSON.parse(responseBody);","pm.globals.set(\"batchNumber\", data.batchNumber);","pm.variables.get(\"batchNumber\");",""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"b8beec96-a0cb-4f0f-b10a-c7ac2a163f37","exec":[],"type":"text/javascript"}}],"id":"08a02ea7-3a42-48b4-b3ff-31152554a325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"Batch\": {\r\n\t\t\"BatchDescription\": \"Collections API\",\r\n\t\t\"CallBackUrl\": \"\",\r\n\t\t\"ClientCode\": \"ZER001\",\r\n\t\t\"ProcessDate\": \"{{today}}\",\r\n\t\t\"ServiceType\": \"1Day\",\r\n\t\t\"TrackingDays\": \"3\",\r\n\t\t\"UniqueId\": \"bca3cf61-db77-41a4-ab03-d9f8fefcfd1d\"\r\n\t},\r\n\t\"Transactions\": [\r\n\t\t{\r\n\t\t\t\"Amount\": 100,\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"SequenceType\": 1\r\n\t\t}\r\n\t]\r\n}"},"url":"https://sandbox-api.paysoft.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:
\nBatch
\nTransactions
\nThe Batch contains essential information about the batch.
\nBatch properties:
\nClientCode (Required. Your unique client code)
\nProcessDate (the date the batch will be submitted to the bank)
\nTrackingDays (Required. 1 - 10)
\nServiceType (Required. Only 1Day is currently accepted)
\nBatchDescription (Required)
\nUniqueId (Optional. This has to be unique between batches to prevent duplicate batches from being submitted)
\nCallBackUrl (Optional. If not set, the ClientService callback url will be used.)
\nEach Transaction item has the following properties:
\nAn existing mandate reference (Required)
\nA debit sequence type (Required)
\nFirst collection = 1
\nOnce off = 2
\nRe-occurring = 3
\nRe-presented = 4
\nFinal collection = 5
\nA customer code (Optional)
\nAn amount (Optional)
\nThe following data is returned:
\nA generated BatchNumber (which can be used in confirming and viewing the detailed validations)
\nNumber of successful transactions (those which passed all validation)
\nNumber of unsuccessful transactions (those which failed validation)
\nTotalTransactions (successful plus unsuccessful transactions)
\nSuccessfulTransactionsAmountTotal (amount in Rands)
\nUnsuccessfulTransactionsAmountTotal (amount in Rands)
\nGrandTotal (amount in Rands)
\nValidation Result Message
\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.
\nSplit Payout Rules:
\nSplit payout rules can be defined in the same payload. Split payout rules allow this collection of funds to be paid out to multiple parties when the funds are received.
\nTo configure the split payout rules a Splits property can be included in each of the required Transaction items. This property will support multiple split rules that can be used to define how the collection funds should be distributed on payout, allowing you to define the amount or percentage, the account, the reference, and a customer code that should be used.
\nSplit Element
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}},"urlObject":{"path":["debicheck"],"host":["https://sandbox-api.paysoft.co.za"],"query":[],"variable":[]}},"response":[{"id":"6b06b83c-ae0d-4355-81e9-ff9642c681b0","name":"Success response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Transactions\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 100,\r\n\t\t\t\"SequenceType\": 1\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 200,\r\n\t\t\t\"SequenceType\": 1\r\n\t\t}\r\n\t],\r\n\t\"Batch\": {\r\n\t\t\"ProcessDate\" : \"{{today}}\",\r\n\t\t\"ClientCode\": \"ZER001\",\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":"{{baseUrl}}/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":"fe6c9cd0-7bfe-470d-9fdb-f22d7234579f","name":"Success response - Split Payout","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Transactions\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 100,\r\n\t\t\t\"SequenceType\": 1,\r\n\t\t\t\"Splits\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Reference\": \"MY_COURIER\",\r\n\t\t\t\t\t\"Type\": 0,\r\n\t\t\t\t\t\"Value\": 25.00,\r\n\t\t\t\t\t\"AccountCode\": \"COURIER\",\r\n\t\t\t\t\t\"AccountNumber\": \"123456789\",\r\n\t\t\t\t\t\"BranchCode\": \"632005\",\r\n\t\t\t\t\t\"CustomerCode\": \"Solomon Mbeki\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Reference\": \"SANTAM\",\r\n\t\t\t\t\t\"Type\": 0,\r\n\t\t\t\t\t\"Value\": 75.00,\r\n\t\t\t\t\t\"AccountCode\": \"INSURANCE\",\r\n\t\t\t\t\t\"AccountNumber\": \"123456789\",\r\n\t\t\t\t\t\"BranchCode\": \"632005\",\r\n\t\t\t\t\t\"CustomerCode\": \"Package Insurance\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 200,\r\n\t\t\t\"SequenceType\": 1,\r\n\t\t\t\"Splits\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Reference\": \"MY_COURIER\",\r\n\t\t\t\t\t\"Type\": 0,\r\n\t\t\t\t\t\"Value\": 100.00,\r\n\t\t\t\t\t\"AccountCode\": \"COURIER\",\r\n\t\t\t\t\t\"AccountNumber\": \"123456789\",\r\n\t\t\t\t\t\"BranchCode\": \"632005\",\r\n\t\t\t\t\t\"CustomerCode\": \"Solomon Mbeki\"\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Reference\": \"SANTAM\",\r\n\t\t\t\t\t\"Type\": 0,\r\n\t\t\t\t\t\"Value\": 100.00,\r\n\t\t\t\t\t\"AccountCode\": \"INSURANCE\",\r\n\t\t\t\t\t\"AccountNumber\": \"123456789\",\r\n\t\t\t\t\t\"BranchCode\": \"632005\",\r\n\t\t\t\t\t\"CustomerCode\": \"Package Insurance\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t],\r\n\t\"Batch\": {\r\n\t\t\"ProcessDate\" : \"{{today}}\",\r\n\t\t\"ClientCode\": \"ZER001\",\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":"{{baseUrl}}/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\": 300,\n \"unsuccessfulTransactionsAmountTotal\": 0,\n \"grandTotal\": 300,\n \"validationsResultMessage\": \"\",\n\t\"messages\":[],\n\t\"errors\": []\n}"},{"id":"3c631f0a-fca7-4f2c-bfd5-f0ca12713800","name":"Duplicate rejection","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"}],"body":{"mode":"raw","raw":"{\r\n\t\"Transactions\": [\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 100,\r\n\t\t\t\"SequenceType\": 1\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"MandateReference\": \"21001600013160638339148015761559\",\r\n\t\t\t\"CustomerCode\": \"CUSTOMER1234\",\r\n\t\t\t\"Amount\": 200,\r\n\t\t\t\"SequenceType\": 1\r\n\t\t}\r\n\t],\r\n\t\"Batch\": {\r\n\t\t\"ProcessDate\" : \"{{today}}\",\r\n\t\t\"ClientCode\": \"ZER001\",\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":"{{baseUrl}}/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":"08a02ea7-3a42-48b4-b3ff-31152554a325"},{"name":"Confirm Collections Batch","id":"d69b2e0e-e8e4-47cc-8482-02228f30b80e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{baseUrl}}/debicheck/confirm?batchNumber=42500","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":["{{baseUrl}}"],"query":[{"description":{"content":"(Required) The batch number
\n","type":"text/plain"},"key":"batchNumber","value":"42500"}],"variable":[]}},"response":[{"id":"51176768-a39d-4b6d-a434-9a48c87b464d","name":"Processed successfully","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/debicheck/confirm?batchNumber=42500","host":["{{baseUrl}}"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"42500","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}"},{"id":"75cd523a-f459-495f-a827-98a73d34bfa4","name":"Batch is awaiting authorisation","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/debicheck/confirm?batchNumber=42500","host":["{{baseUrl}}"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"42500","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":"a106a931-fbf1-48d8-a3bc-a591b1ede830","name":"Batch Not Found","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{baseUrl}}/debicheck/confirm?batchNumber=42500","host":["{{baseUrl}}"],"path":["debicheck","confirm"],"query":[{"key":"batchNumber","value":"42500","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}"}],"_postman_id":"d69b2e0e-e8e4-47cc-8482-02228f30b80e"},{"name":"View Collection Import Validation Results","id":"6d3a8ec3-df5b-4c91-a37c-6148cc59c346","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"method":"GET","header":[],"url":"{{baseUrl}}/debicheck/validationresults?batchNumber=42500&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":"42500"},{"description":{"content":"(Optional) If left out, all the results will be retrieved
\n","type":"text/plain"},"key":"filter","value":"1"}],"variable":[]}},"response":[{"id":"aa8f7d3b-b3b8-44be-bbce-d14ae0dee80f","name":"All successes","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/debicheck/validationresults?batchNumber=42500&filter=1","host":["{{baseUrl}}"],"path":["debicheck","validationresults"],"query":[{"key":"batchNumber","value":"42500","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}"},{"id":"eae46363-1f87-45c2-93c6-94f43ddd6967","name":"Failure and success","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{baseUrl}}/debicheck/validationresults?batchNumber=42500&filter=1","host":["{{baseUrl}}"],"path":["debicheck","validationresults"],"query":[{"key":"batchNumber","value":"42500","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}"}],"_postman_id":"6d3a8ec3-df5b-4c91-a37c-6148cc59c346"},{"name":"Sample Webhook","id":"4c88255d-948b-49b7-b921-5c1d5e548aa4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nOnce collection results are received from the provider, this call-back url will be used to send the webhook containing the documented DebiCheckResult object. It will be posted as a url encoded form encoded as multipart/form-data.
\nIt is important to note that should a call-back url be configured or provided, results will be relayed as received from the provider.
\nYou can also view the webhook history on the Paysoft portal if users were granted access to it. This will allow users to monitor failures or resend webhooks.
\nThe DebiCheckResult section consists of the following elements:
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[{"id":"dad8b587-39cf-473d-bbf7-a94087b9c6e8","name":"Tracking","originalRequest":{"method":"POST","header":[{"key":"Enctype","value":"multipart/form-data"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"response","value":"\nThe collections API allows one to collect on accepted mandates.
\n","_postman_id":"ac8e1295-10b3-4c4c-8124-b90478f6ce6c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}}],"id":"d76b1302-eed9-4da2-89b6-439c6974b28f","description":"The Paysoft Debicheck API gives developers the opportunity to manage Debicheck Mandates and Collections using their own software solutions. The Debichecck API functions differently to the original Paysoft API in that it makes use of a RESTful service as opposed to the XML form post structure of the original API.
\nContact Paysoft and request access to Debicheck Mandates for a specific user account. Alternatively, Paysoft can setup a new user account specifically for the purposes of accessing the Debicheck 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.
\n","_postman_id":"d76b1302-eed9-4da2-89b6-439c6974b28f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":true,"source":{"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","name":"Latest","type":"folder"}}}],"id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a","description":"The latest APIs makes use of bearer tokens for authentication and using a url encoded form containing the specified keys for the endpoint. In reply each endpoint will respond with a JSON object containing the requested information.
\nThe baseUrl variable value for all TEST API calls is;
\n\nNB: Please contact Paysoft with regards to setting up your test account, as this will use a different user name and password from your live account.
\nThe baseUrl variable value for all LIVE API calls is;
\n\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Bx6o1SCBiUi7sgXr4KVvSDfZKxfbwSDYAVeZBjk7UYU36WsQi0Kq2xnChwlqlfpaF8r0ZLyHrIjKvYJXLLT4fEeENn0pL-tvt9KPXmSrUiq2smQ3Hz8_0mhdgJubZxWIAA6ygWVeNSrnQql5wxs058QXsRmdzBjv4iTbj6-POm7mvgp1ZXVMTKGYIMF5Pu69IZ6iMPmA3Xh6AkYVkKciFYK1FYgYtbZtIkcEUjxzg6wdWgIXuZDnd1fdDyT--LaGbQ_lTuHQ0Hos9gZoejl_eGXdESCqes-A0AJyaz-aAodq8pZg5ChVZNYmxnBFlTPjC_NZXDOd1QuhySpCSYVLLdu0f81mqttgi3M8XhdoxrJ5EELuSg2f9hWmob7Z64vaQV7aPO6DCVS7KbbqNWcPzeWccaM"}]},"isInherited":false},"_postman_id":"90cfb3fc-4d54-40e7-bc1c-719bf4a4ca5a"},{"name":"Deprecated","item":[{"name":"Naedo","item":[{"name":"NAEDO","event":[{"listen":"prerequest","script":{"id":"df96335e-7759-49cf-9e3a-8aa69db3ef36","exec":["const moment = require('moment');\r","pm.globals.set(\"today\", moment().format(\"YYYYMMDD\"));"],"type":"text/javascript"}},{"listen":"test","script":{"id":"4fb8df30-9c63-4959-9435-2d36160d24a3","exec":[""],"type":"text/javascript"}}],"id":"03b4b2e9-6998-40b0-87b5-b433c441ad1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"key","value":"{{apiKey}}","type":"text","description":"Contact Paysoft and request an API key. Your API key will be used with every request to identify your application. If no key is provided, then access to the data will not be granted. An incorrect key will result in the same error.
\n"},{"key":"request","value":"