Modify a Direct Debit

patch https://api.test.payadvantage.com.au/v3/direct_debits/{code}

Updates an existing direct debit. It is only necessary to provide a value for the fields that you wish to update.

This endpoint currently only supports updating the direct debit status, but will be extended to change the DDR settings in the future.

Responses

Response body

object

Code

string

required

Unique internal identifier assigned to the direct debit by Pay Advantage. This cannot be changed.

AuthorisationLink

object

required

A direct debit request link that can be sent to, or shared with a customer digitally. The customer follows the link to the hosted page portal where they can complete signing the DDR. Once signed the DDR status will be pending.

Link

string

Link URL

Expiry

date

required

Date and time of when the direct debit request link expires.

DateCreated

date

required

Date and time direct debit was created e.g. datecreated=ddMMyyyy

Status

string

The status of the direct debit.

Draft Pending Rejected Active Paused Cancelled Complete

Customer

object

Code

string

Unique customer code.

Name

string

Customer's name. If the customer is not a business, this field will return the firstname and lastname of a customer.

CustomRef

string

Custom reference number for a customer.

Description

string

The direct debit description. e.g. "Membership Fees".

ExternalID

string

An external identifier for your application. Setting this value will allow you to query payments using the same external ID reference. This is useful will allow you to marry up the payments that were deducted based on a DDR external ID reference

UpfrontAmount

double

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. No value is returned if the direct debit has no upfront amount.

UpfrontDate

date

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.

RecurringDateStart

date

required

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.

RecurringAmount

double

required

This is the recurring amount that will be charged every instalment. Upfront amounts are always charged separately to the recurring amount. Enter value as a currency amount in AUD e.g. 15.50

Frequency

string

Specifies the frequency instalments will occur from the recurring start date.

weekly fortnightly monthly quarterly yearly

EndConditionAmount

double

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.

FailureOption

string

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 portal.
Information about these options

pause next 1week 2weeks 3days addtoend

OnchargedFees

string of strings

The fees that are on-charged for this direct debit.
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

dishonor perdebit

NextInstallmentDate

date

The date of the next installment.

NextInstallmentAmount

double

The amount inclusive of fees for the next intallment.

Installments

array of objects

The direct debit installments.

Installments

object

DateScheduled

date

required

The date that the installment is scheduled to be processed.

DateProcessed

date

The date and time that the installment was processed, otherwise null.

Amount

double

required

The installment amount excluding any fees.

EstimatedFee

double

required

The estimated fee amount for the installment. This amount does not include unpaid installment fees.

ReminderSent

boolean

required

Indicates whether an upcoming installment reminder has been sent to the customer.

IsCatchUp

boolean

required

Indicates if the installment is a catch-up installment for a previously missed installment.

Payment

object

Language

Credentials

Header


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://api.test.payadvantage.com.au/v3/direct_debits/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad request.

401User is not authorized.

403The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort.

404The requested resource could not be found.

422The request was well-formed but was unable to be followed due to semantic errors.

429Request limit exceeded.

500Internal server error.

504Gateway timeout.