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 title of the subscription template.

string
required
length between 1 and 50

The description to use when creating DDRs from this template.

int32
required

The version of the subscription details.

boolean
required

Whether this subscription template is recommended. Defaults to false.

double | null

The amount to be charged upfront.

string
enum
Allowed:
int32 | null

The number of days for the upfront date condition.

date | null

The specific date for the upfront payment.

double
required

The amount to be charged on a recurring basis.

string
enum
required
Allowed:
string
enum
Allowed:
date | null

The specific start date for the subscription.

double | null

The total amount after which the subscription should end.

int32
enum
Allowed:
int32 | null

The number of days before a payment to send a reminder. Defaults to 1 if not provided.

string of objects | null
enum

The fees to be on-charged to the customer. If this isn't provided, these will default based on your merchant settings in the PayAdvantage portal.
Valid values include: dishonour - charge the fees for payment failures back to the customer, perdebit - charge the per debit fee and msf to the customer,
setup - charge the setup fee to the customer, reminder - charge the reminder fee to the customer

Allowed:
boolean | null

Whether the subscription template is active. Defaults to true if not provided.

Benefits
array of strings | null

The benefits of the subscription.

Benefits
string | null

Keywords associated with the subscription template, shown when the template is recommended.

string | null

This is used to describe the subscription template.

string | null

The call-to-action text for the subscription template.

string | null

Base64-encoded image data for the subscription template.

string
enum
required
Allowed:
string | null

The code of the Digital Agreement document to associate with this template. Templates with a digital agreement can only be used to create digital direct debits — attempting to use such a template for a paper direct debit will be rejected.

boolean | null

When updating a template, if SubscriptionDetails fields have changed, this flag determines whether to update all existing active DDRs to the new version (true) or keep them on the current version (false).

Responses

Updated 12 days ago

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

Updated 12 days ago