Update a Debit Batch

For processing batch payments using the Pay Advantage API you will need to use both Debit Batches and Debit Instructions.

Debiting instructions are individual records of bank account payment instructions.
Debit batches are used to schedule and group individual debit instructions together.
This endpoint is useful for the management and submission of large batches of payments.

As debit batches are processed twice a day, it is recommended to include all instructions for that day into a single batch.
To use this endpoint, you must first create a debit batch group and then append instructions for each account you want to debit. This is done using the Debit Instructions endpoint.

When the batch contains all the debit instructions you want to process, the batch needs to be authorised and all instructed payments will be scheduled for processing.



Updates a debit batch group using its code as an identifier. This will not modify the instructions associated with the batch debit. If a parameter is not included in the request body, it will not be updated.

Path Params
string
required
length between 6 and 12
Body Params
string
required
length between 1 and 50

Will be appended as the name of this debit batch group. Used to help you easily identify debit batch groups from each other.

date | null

Set a date for the debit batch group to process debits on. The date must be either the day of creation, or a future date. A date in the past will return an error.

string | null

The remitter name that appears on customers bank statements to let them know why they have been debited. You can set this as null and it will use the default remitter name for your account. This is the recommended use of this field.

Responses

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