API Reference
Guides

Create a new Direct Debit from Template

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

Creates a direct debit from a subscription template. All amounts, frequency, fees and end conditions are taken from the template's current version; only scheduling and authorisation options may be supplied.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
Customer
object
required
Template
object
required
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.

integer | null
0 to 3

Overrides the template's reminder days (0-3). Does not detach the direct debit from the template. Inherits the template value when omitted.

date | null
^\d\d\d\d\-\d\d\-\d\d$

Overrides the recurring start date. On this endpoint a StartDate supplied without StartDateCondition is treated as 'on_date'. Does not detach from the template.

string
enum

Overrides the template's recurring start condition. Does not detach from the template.

Allowed:
date | null
^\d\d\d\d\-\d\d\-\d\d$

Overrides the upfront date. On this endpoint an UpfrontDate supplied without UpfrontDateCondition (and without UpfrontDateDays) is treated as 'on_date'. The upfront amount always comes from the template. Does not detach from the template.

int32 | null

Overrides the upfront day offset. Required when UpfrontDateCondition is 'days_before_first_instalment' or 'days_after_first_instalment'. If UpfrontDateDays is supplied without a condition the request is rejected (ambiguous). Does not detach from the template.

string
enum

Overrides the template's upfront date condition. Does not detach from the template.

Allowed:
Responses

Updated about 1 hour 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 about 1 hour ago

Did this page help you?