API Reference
Guides
Start typing to search…

Create a new Direct Debit

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

Generate a direct debit (Recurring payment).
Direct Debits are required to be authorised to become active.

One authorisation method is to share the direct debit request link with a customer allowing them to authorise and sign the direct debit request.

The other method is to submit the direct debit request with CustomerAuthorisationNotRequired = true. This will create an active direct debit without your customer required to authorise and sign.
You should offer the ability for your customer to cancel their subscription via your platform if bypassing customer authorisation.

Your customer must have a valid email and mobile number, or your request will fail and an appropriate error will be returned. You will need to update your customers details using the customer endpoint to include an email and mobile number.

Body Params
Customer
object
required
string
required
length between 1 and 50

The direct debit description. Write something that communicates purpose of these payments e.g. "Membership Fees".

string | null

The entities ID from the external system that created it.

double | null
Defaults to 100

The total amount that will be charged for a one-off upfront payment e.g. UpfrontAmount=25.50. Use this if you want the first amount to have a discount, or bundle any setup costs into the first payment. If an upfront amount is not desired, do not set this value.

date | null
Defaults to 2023-10-01

The date on which the upfront amount is to be charged. If the request hasn't been signed or approved before the declared date, instalments will not be processed and the request link will become invalid.

double | null
required
Defaults to 100

This is the recurring amount that will be charged every instalment. If there is a first amount set, the first instalment will not use this amount. Enter value as a currency amount in AUD e.g. 15.50

date | null
required
Defaults to 2023-10-01

The date on which recurring payments will begin. If the request hasn't been signed or approved before the declared date, instalments will not be processed and the request link will become invalid.

string | null
enum
required
Defaults to weekly

Specifies the frequency instalments will occur from the start date.

Allowed:
double | null

Lets you set a total amount to be paid at which point the direct debit will complete e.g. 1200.00 would process instalments until $1,200 is paid. This value can be set to null. If set to null the direct debit will only end when it is manually cancelled by you.

string | null
enum
required

The action automatically taken when a direct debit instalment fails. If no value is set these will default based on your failures and fees defaults that can be set through the PayAdvantage user interface.
Valid strings include: pause, next, 1week, 2weeks, 3days, addtoendInformation about these options

Allowed:
integer
required
0 to 3

The number of days before a debit is due to send a debit reminder to the customer. Must be a value between 0 and 3 (0 = no reminder is sent).

OnchargedFees
array of strings | null
required

Choose what fees you want to on-charge for this direct debit. If this isn't posted in the request these will default based on your customer setting in the PayAdvantage portal.
Valid strings include: dishonor - charge the fees for payment failures back to the customer, perdebit - charge the per debit fee and msf to the customer

OnchargedFees*
CustomerPaymentAccount
object
boolean | null

Submits the direct debit for authorisation and approval immediately without customer intervention. To use this option a Customer Payment Account is required.

Responses

Updated about 2 months ago

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