API Reference
Guides

Create a new Direct Debit Template

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

Creates a new subscription template.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 50

The template's name, shown to merchants when choosing a template. Max 50 characters.

string
required
length between 1 and 50

The payment description applied to direct debits created from this template. Max 50 characters.

boolean | null

Whether to highlight this template as recommended to customers. Defaults to false.

double | null

Optional one-off amount charged before the recurring schedule begins (e.g. a deposit or setup fee). Omit for no upfront payment.

string
enum

When the upfront amount is charged: today, a fixed on_date, or a number of days before/after the first instalment. Required when an upfront amount is provided.

Allowed:
int32 | null

Days before/after the first instalment to charge the upfront amount. Required when the upfront date condition is days_before_first_instalment or days_after_first_instalment.

date | null

Exact date to charge the upfront amount. Required when the upfront date condition is on_date.

double
required

Amount charged each recurring instalment, in AUD.

string
enum
required

How often recurring instalments are charged (e.g. weekly, monthly). Defaults to weekly.

Allowed:
string
enum
required

When the recurring schedule starts: today or a fixed on_date. Defaults to today.

Allowed:
date | null

Exact date the recurring schedule starts. Required when the start date condition is on_date.

double | null

Optional total amount at which the subscription completes; once this much has been collected, no further instalments are taken. Omit for an open-ended subscription.

string
enum
required

How a failed (dishonoured) payment is handled. Defaults to addtonext.

Allowed:
int32 | null

Days before each payment to send the customer a reminder (0–3; 0 = no reminder). Defaults to 1.

string of objects | null
enum

Which fees are passed on to the customer. If omitted, your merchant default applies.
Valid values: setup - charge the setup fee, perdebit - charge the per-debit fee and MSF, dishonour - charge payment-failure fees, reminder - charge the reminder fee.

Allowed:
boolean | null

Whether the template can be used once created. Defaults to true.

Benefits
array of strings | null

Optional selling-point lines shown to customers on the hosted payment page.

Benefits
string | null

Optional short badge shown when the template is marked recommended (e.g. "Best value"). Max 50 characters.

string | null

Optional longer description of the template shown to customers on the hosted payment page. Max 100 characters.

string | null

Optional call-to-action label for the template's button on the hosted payment page (e.g. "Join now").

string | null

Optional base64-encoded image (PNG, JPG, GIF or SVG) shown for this template on the hosted payment page.

string
enum

Whether the template appears in your public template selection (public) or is hidden (private). Defaults to public.

Allowed:
string | null

Optional code of a Digital Agreement to attach. Templates with a digital agreement can only create digital direct debits, not paper forms.

Responses

Updated about 2 months ago

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

Updated about 2 months ago