API Reference
Guides

Bulk increase direct debit recurring amounts

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

Increases the recurring amount of the specified direct debits by a percentage (maximum 10%) or a fixed dollar amount. Direct debits that would exceed trust limits or require re-authorisation are skipped and reported in the response rather than failing the whole request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Codes
array of strings
required
length between 1 and 500

The direct debits to adjust, identified by their codes.

Codes*
string
enum
required
Allowed:
double
required
0.01 to 999999

The amount to increase by: a percentage (max 10) when AdjustmentType is 'percentage', otherwise a fixed dollar amount.

boolean
required

When true, customers are not emailed about the change. When false (default), the amount-change email is sent.

Responses

Updated 1 day ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 1 day ago

Did this page help you?