API Reference
Guides
Start typing to search…

Create a new Debit Instruction

post
https://api.test.payadvantage.com.au/v3/debit_instructions

For processing batch payments in the Pay Advantage API you will need to use both Debit Batch and Debit Instruction API.Debit Instructions are individual instructions to debit an amount from a bank account. Unlike DDR's, debit batch instructions have no schedule management, The batch is simply used to process a batch of payments and record the success or failure of each payment instruction on the day of submission.

Debit Batches
Before creating debit instructions you must first create a debit batch group that will be used to control certain functions like the debit date etc for all of the instructions. See debit batches for more information.

On-Charging Fees
If you decide to on-charge debit fees directly to your customers then you can make use of the OnchargeFees flag and PayAdvantage will pass on the selected fee to the customer.
Debit Fees will be calculated when the Debit Instruction is processed for payment (typically the DateToDebit from the DebitBatch). The fee will be added to the payment at this point for on-charged debit instructions.

Group Key Feature
Any Debit Instruction may have a Group Key assigned. As the name suggests, this field is used for grouping related instructions together. The same group key may be used across any number of batches over any period of time. A good idea is to use a customers unique code or identifier for this field.Please be aware that, when using the Group Key and On-charge features together, any on-charged fee that dishonours will be added to the next on-charged debit instruction with a matching group key. This is by design to assist in fee management and recovery. It is only a real concern if on-charging is used and the group key is shared between different customers. One solution in this scenario is to add a unique suffix to group key for each customer in that group (for example AB001-01, AB001-02) so these can be filtered at a later date using the first number characters.


Create a Debit Instruction and add it to an already existing Debit Batch. A Debit Instruction must be appended to a Debit Batch Group.

Body Params
DebitBatch
object
required
DebitInstructions
array of objects
required
length between 1 and 1000
DebitInstructions*
string | null

Bank account number of account being debited. Required if CustomerPaymentAccountCode is not provided.

string | null

Name of the account being debited. Required if CustomerPaymentAccountCode is not provided.

string | null

The BSB number of the account being debited as a string. Required if CustomerPaymentAccountCode is not provided.

string | null

Customer Payment Account code to use instead of providing BSB and Account details. If provided, BSBNumber, AccountNumber, and AccountName should be omitted.

double
required

The amount to be debited as a currency amount in AUD e.g. 15.50.

string | null

The remitter name that appears on customers bank statements. This will default to your registered remitter name, providing a value in this field will be ignored without the correct permission.

string
required
length between 1 and 50

An optional placeholder for your own system ID.

string | null

Optional field for grouping related instructions together. The same group key may be used across any number of batches over any period of time. These are covered in more detail in the overview of the Debit Instruction endpoint at the top of this page.

boolean
required

Flag that indicates if debit fees are oncharged to the customer or not. If true, any additional service fees will be added to the amount to be debited.

Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago