Uploading a Debit Order batch via API

Uploading a Debit Order batch via API

To upload a Debit Order batch via API, you can use the sample below.


The API documentation: https://help.rapidpaycollect.co.za/support/solutions/articles/69000335540-rapid-pay-collect-debit-order-collections-and-payments-api-


Please make sure you add your key in the endpoint, and your client code in the request.


Endpoint: https://sandbox.rapidpaycollect.co.za/API/DebitOrder?key=fc301277-xxxx


To make a request, include the parameter 'request' in the body of your request and use a value that (for example) looks like:


<APIDebitOrdersRequest>
<Header>
<PsVer>2.0.1</PsVer>
<Client>XXX001</Client>
<Service>DebitOrder</Service>
<ServiceType>2Day</ServiceType>
<UniqueId>123</UniqueId>
<Duedate>20180707</Duedate>
<Reference>Rapid test</Reference>
<CallBackUrl></CallBackUrl>
</Header>
<DebitOrders>
<FileContents>
<FirstNames>xxx</FirstNames>
<Surname>xxx</Surname>
<BranchCode>203809</BranchCode>
<AccountNumber>xxxx</AccountNumber>
<FileAmount>5.00</FileAmount>
<AmountMultiplier>1</AmountMultiplier>
<Reference>rapid test 1234</Reference>
</FileContents>
</DebitOrders>
<Totals>
<Records>1</Records>
<Amount>5.00</Amount>
<BranchHash>203809</BranchHash>
<AccountHash>xxxx</AccountHash>
</Totals>
</APIDebitOrdersRequest>


A tokenized <FileContents> sample could be:



<FileContents> 



   <CustomerCode>456</CustomerCode> 



   <Token>35E7D515C510874xxxx</Token> 



   <AmountMultiplier>1</AmountMultiplier> 



   <FileAmount>5.00</FileAmount> 



   <Reference>Rapid test</Reference> 



</FileContents>
 
You can tokenize customers on the Rapid Pay Collect Platform or via the API.


If you want to apply for a facility with Rapid Pay Collect, please find our Application Form attached hereto.

Please email our Sales Team at: sales@rapidpaycollect.co.za with the fully completed application form as well as the supporting documents as requested.



For your convenience, we have also attached our API Specifications document, for Debit Order Collections and Payments, for integration into your own software systems>>>> See attached API Technical Specification Document.

    • Related Articles

    • How to test the Debit Order API - SANDBOX Environment?

      We create a TEST/SANDBOX account to simulate Debit Order processing on a continuous basis. This will include : TEST API key TEST Client code TEST URL: sandbox.rapidpaycollect.co.za Payments submitted to this test system do not get processed (client's ...

    • Batch Upload Cut-Off times

      Debit order batches need to be uploaded before a certain cut-off time to be processed. The cut-off time depends on the Service Type that you use: Same Day (SDV), 1Day and 2Day.   Cut-off times per service type: Service type Cut-off time SDV 14h00 ...

    • Debit Orders (Recurring) - Loading and Managing Beneficiaries

      By loading Debit Order beneficiaries on the system, the system will automatically generate the batch on the correct date every month for processing. So this enables you to process recurring debit orders. This can be done manually, or via API - see ...

    • How to Upload a Payout Batch?

      To upload a PAYOUT BATCH and send money to your suppliers, customers or partners, employees (salary payments etc), you can follow the steps below: Prepare the CSV sample file provided by Rapid Pay Collect: 1.    Log into the Rapid Pay ...

    • Settlement of Debit Orders into your banking account

      Once your debit orders batch is processed, all transactions will show as 'Complete'. After this the status might change to Unpaid (ie. because of insufficient funds, invalid account or the customer rejecting the debit order). Settlements into your ...