Retrieve Customers

get

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

Pay Advantage allows your business to manage customers and their details in the Pay Advantage portal. Storing phone numbers, email addresses and notes for each customer provides a handy tool for managing your customers.

Returns a list of customers sorted by name (ascending by default). The list is paged and will always return the first page of records.

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,dateupdated,-dateupdated,name,-name,firstname,-firstname,lastname,-lastname,customref,-customref,dob,-dob

sort

code

string

length between 6 and 6

Unique code internal identifier assigned to the customer by Pay Advantage. This will return a single customer record.

clientid

int32

Merchant Identifier used to filter customers based on the client Identifier

externalid

string

length between 0 and 50

Identifier from an external system that can be appended to this customer. This is useful if you are syncing Pay Advantage with another system or your own internal database.

datecreated

date-time

length between 8 and 33

Returns customer records based on date and time customer was created.

This field accepts date strings as either YYYYMMDD or DDMMYYYY. datecreatedto and datecreatedfrom allow you to submit a range of dates.

datecreatedfrom

date-time

length between 8 and 33

datecreatedto

date-time

length between 8 and 33

dateupdated

date-time

length between 8 and 33

Returns customers who were updated on the specified date.

This field accepts date strings as either YYYYMMDD or DDMMYYYY. Using null as a value will return all customers who have never been updated. dateupdatedto and dateupdatedfrom allow you to submit a range of dates.

dateupdatedfrom

date-time

length between 8 and 33

dateupdatedto

date-time

length between 8 and 33

datejoined

date

length between 8 and 10

Returns customers based on date joined. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

datejoinedfrom

date

length between 8 and 10

Returns customers based on date joined. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

datejoinedto

date

length between 8 and 10

Returns customers based on date joined. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

name

string

length between 2 and 80

Returns customer with the selected business name. If the customer type is a "Consumer" do not use this attribute.

firstname

string

length between 1 and 50

Returns customers by the first name of the customer, or the first name of a businesses primary contact

lastname

string

length between 1 and 50

Returns customers by the last name of a customer, or the last name of a businesses primary contact

customref

string

length between 2 and 20

Returns customers by the Custom Reference Number

string

length between 2 and 200

Returns customers by their primary email address. Customers primary email address. This address is used for sending payment receipts, alerts, and is required for a customer to authorise a direct debit eg. [email protected]

mobile

string

length between 2 and 20

Returns customers by their mobile phone number. This string doesn't accept special characters such as and should be a local number instead i.e. don't pass +61400000000 instead use 0400000000

anyphone

string

length between 1 and 20

Returns customers by any of their phone numbers. This string doesn't accept special characters such as and should be a local number instead i.e. don't pass +61400000000 instead use 0400000000

bpayref

string

length between 2 and 10

Returns customers by their BPay number.

isconsumer

boolean

Flag that returns customers according to whether their a "Consumer" or "Business". Returns true for "Consumer" and false for "Business".

dob

date

length between 8 and 10

Returns customers based on date of birth. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

dobfrom

date

length between 8 and 10

Returns customers based on date of birth. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

dobto

date

length between 8 and 10

Returns customers based on date of birth. This field accepts date strings as either YYYYMMDD or DDMMYYYY e.g. dob={ddMMyyyy}

isactive

boolean

Indicates whether the customer is active or not. A customer must have no active direct debits, or pending payment requests to be set to inactive. Returns a list of active or inactive customers e.g. isactive=true will return only active customers.

paymentsettlement

string

Retrieves customers filtered by payment settlement status: allowed, stopped, or all customers.

customfield1

string

length between 1 and 80

Returns customers based on their custom field 1 value.

customfield2

string

length between 1 and 80

Returns customers based on their custom field 2 value.

customfield3

string

length between 1 and 80

Returns customers based on their custom field 3 value.

Responses

200Customers 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