Managed Subscriptions/Recurring Debits

Managed direct debits let you create set and forget subscriptions where we will manage the daily processing and handling of debits based on a specific start date, frequency and end goal.

 

 

Creating a Direct Debit - POST: /direct_debits

To create a new Direct Debit, you need to post to the address above.

{
Customer: { Code: "ABC123" },
Description: "Gym Membership",
Reference: "YOURREF",
Functions: [
{
Name: "Ongoing",
DateStart: "2019-09-17",
Amount: 200,
Frequency: "weekly",
FailureOption: "3days",
OnchargedFees: [ "dishonour" ],
EndCondition: { Date : "2019-10-20" }
},
{
Name: "Upfront",
DateStart: "2019-09-17",
Amount: 123.45
}
],
OnChargedFees: ["dishonour","perdebit"]
}

The "OnChargedFees" field can contain any or all of the values "dishonour", "perdebit" and "setup" which, if present, will on-charge the payment dishonour, direct debit and per schedule fees respectively.

The "Frequency" field allows the nomination of "weekly", "fortnightly", "monthly" or "quarterly" direct debit schedules.

The supported "FailureOption" values are:

  "pause" - Pause the Direct Debit Schedule

  "next" - Add to next payment

  "1week" - Debit in one week

  "2weeks" - Debit in two weeks

  "3days" - Debit in three days

  "addtoend" - Append after last scheduled payment

 

Deleting a Direct Debit - DELETE: /direct_debits/{code}

To delete a Direct Debit, you need to post to the address above and include the identifier for the Direct Debit in “{code}”. 

 

Direct Debit Record - GET: /direct_debits/{code}

An example of a direct debit record is shown below. This is the record that is returned on request of a single record and an array of these records is returned when requesting lists.

{
  "Code": "ABC123",
  "Description": "Gym Membership",
  "ExternalID": null,
  "Customer": {
    "Code": "C12345",
    "Name": "First Last",
    "CustomRef": null
  },
  "DateCreated": "2018-10-03T16:41:06.63",
  "AuthorisationLink": {
    "Link": "https://payadvantage.com.au/Authorise/DDAuthorise.aspx?code=1234abcd-1234-abcd-1234-a1111a11111a",
    "Expiry": "2018-11-02T00:00:00"
  },
  "Status": "Draft",
  "OnchargedFees": ["dishonour"],
  "Functions": [
    {
      "Frequency": "weekly",
      "FailureOption": "3days",
      "EndCondition": { "Amount": null, "Date": "2019-10-20T00:00:00" },
      "Name": "Ongoing",
      "DateStart": "2019-09-17T00:00:00",
      "Amount": 200
    },
    {
      "Frequency": "weekly",
      "FailureOption": "3days",
      "EndCondition": { "Amount": 200, "Date": null },
      "Name": "Upfront",
      "DateStart": "2019-09-17T00:00:00",
      "Amount": 200
    }
  ]


Lists of Direct Debits - GET: /direct_debits

Direct Debits are sorted by creation date (most recent first) by default. The list is paged and will always return the first page of records unless paging parameters are added as described in Retrieving and Filtering Lists. An example of the response is shown below

{
  "Records": 
  [
    {
  "Code": "ABC123",
  "Description": "Gym Membership",
  "ExternalID": null,
  "Customer": {
    "Code": "C12345",
    "Name": "First Last",
    "CustomRef": null
  },
  "DateCreated": "2018-10-03T16:41:06.63",
  "AuthorisationLink": {
    "Link": "https://payadvantage.com.au/Authorise/DDAuthorise.aspx?code=1234abcd-1234-abcd-1234-a1111a11111a",
    "Expiry": "2018-11-02T00:00:00"
  },
  "Status": "Draft",
  "OnchargedFees": ["dishonour"],
  "Functions": [
    {
      "Frequency": "weekly",
      "FailureOption": "3days",
      "EndCondition": { "Amount": null, "Date": "2019-10-20T00:00:00" },
      "Name": "Ongoing",
      "DateStart": "2019-09-17T00:00:00",
      "Amount": 200
    },
    {
      "Frequency": "weekly",
      "FailureOption": "3days",
      "EndCondition": { "Amount": 200, "Date": null },
      "Name": "Upfront",
      "DateStart": "2019-09-17T00:00:00",
      "Amount": 200
  }
]
},
  {…} ], "Meta": { "page": 0, "recs_per_page": 100, "total_recs": 500 } }

 

 

Have more questions? Submit a request

Comments