Acknowledge a failure in the batch

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.

This endpoint allows you to mark failures as acknowledged. This provides a fast method for identification of which records have been dealt with.Once acknowledged, failed debit instructions will stop appearing in the returned list of failed debit instructions.You can acknowledge a single failure or multiple by separating the {code} with a comma. You can acknowledge up to a maximum of 1,000 codes per delete request e.g. v3/debit_instructions/{code},{code},{...}/ackfail.

The PUT, POST and PATCH perform the exact same function of marking the failure as acknowledged.

Click Try It! to start a request and see the response here!