Retrieve Direct Debits

get

https://api.test.payadvantage.com.au/v3/direct_debits

Returns a list of direct debit records ordered by creation date. The list is paged and will always return the first page of records. If there are no records that match your search you will be returned an empty list.

Query Params

page

integer

≥ 0

Defaults to 0

Responses are paged to return a limited amount of records. This parameter is used to retrieve a specific page number.

per_page

integer

0 to 1000

Defaults to 100

The number of records per page to retrieve.

sort

array of strings

A comma seperated list of fields to sort by. Fields prefixed with a "-" will sort in descending order.
The fields include: datecreated,-datecreated,customer.name,-customer.name

sort

code

string

length between 6 and 6

Unique internal identifier assigned to the direct debit by Pay Advantage. This cannot be changed. This filter will return a single record.

customer.code

string

length between 6 and 6

Unique internal identifier of the customer making the direct debit payment. This will return direct debits associated with this customer.

datecreated

date-time

length between 8 and 33

Returns direct debit records based on date and time they were created. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. datecreated=ddMMyyyy

datecreatedfrom

date-time

length between 8 and 33

Returns direct debit records based on date and time they were created. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. datecreated=ddMMyyyy

datecreatedto

date-time

length between 8 and 33

Returns direct debit records based on date and time they were created. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. datecreated=ddMMyyyy

onchargedfees

string

Returns direct debit records with on charged fees if set to true.

recurringamount

number

Returns direct debit records by the recurring amount that will be charged every instalment. If the DDR has a upfront amount the value is not considered in this filter. This value is a currency amount in AUD e.g. 15.50

recurringamountfrom

number

recurringamountto

number

frequency

string

Returns direct debit records by the associated frequency. Request values include: weekly,fortnightly,monthly and quarterly

status

string

Returns direct debit records by the associated status. Request values include: draft, active, pending, rejected, paused, cancelled, complete

externalid

string

length between 1 and 50

Returns direct debit records using the external ID appended to a direct debit request.

Responses

200Direct Debits matching the search criteria

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