API Reference
Guides
Start typing to search…

Create a new Customer

post
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.


Creates a new customer using any attributes sent in request body.
Two customer types can be created - A Consumer or a Business.
To generate a BPAY reference for your customer on creation you will need to add ?with=bpayref to the end of the url.

To generate a persistent PayID for your customer on creation you will need to add ?with=payidref to the end of the url.

To setup a direct debit or use features such as payment requests, customers require a mobile number and email address.
It is recommended you create all new customers with a mobile number and email to enable all Pay Advantage features for your customers.

Body Params
string | null

The entities ID from the external system that created it.

boolean
required

Flag that indicates customer type. True is a "Consumer" and false is a "Business". Changing this will update the customer type. If you change a customer to a business you must also update the parameter name to be a business name.

string | null

This attribute is used to store a business name for type "Business" or it will also be populated with the full name for type "Consumer".

string | null

The first name of a customer, or the first name of a businesses primary contact. When the customer type is "Consumer" this field is required.

string | null

The last name of a customer, or the last name of a businesses primary contact. Generally it is a good idea to include this field.

string | null

Stores a custom reference number against a customer.

string | null

The customers primary email address. This address is used for sending payment receipts, alerts, and is required for a customer to authorise a direct debit.

boolean
required

Controls whether the customer will be automatically sent emails on Direct Debit payment failures. If true emails will be automatically sent, if false no email will be sent.
If not set this is derived from your current default setting configured in your Pay Advantage portal's customer settings.

boolean
required

Controls whether the customer will be automatically sent email receipts for payments. If true emails will be automatically sent, if false no email will be sent. If not set this is derived from your current default setting configured in your Pay Advantage portal's customer settings.

string | null

Controls whether the customer will be sent an email with their BPAY details when it is generated by the PayAdvantage system. Allowed options are default, force_do_not_send, force_send.

date | null

This is an optional attribute that can be appended to a customer to record their date of birth.

string | null

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

integer | null

The Country ID of a customers primary phone. The full list of Country ID's can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

string | null

The ISO code corresponding the country the primary phone is located in e.g. Australia is AU. Full list of country ISO and related codes can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

PhoneNumber
object
string | null

Customers home phone number. This string doesn't accept special characters such as and should be a local number instead i.e. don't pass +61700000000 instead use 0700000000

integer | null

The Country ID of a customers home phone.The full list of Country ID's can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

string | null

The ISO code corresponding the country the home phone is located in e.g. Australia is AU. Full list of country ISO and related codes can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

HomePhoneNumber
object
integer | null

The Country ID of a customers address.The full list of Country ID's can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

string | null

The ISO code corresponding the country the address is located in e.g. Australia is AU. Full list of country ISO and related codes can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

string | null

Customers 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

integer | null

The Country ID of a customers mobile phone. The full list of Country ID's can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

string | null

The ISO code corresponding the country the mobile phone is located in e.g. Australia is AU. Full list of country ISO and related codes can be found at: https://docs.payadvantage.com.au/docs/country-iso-ids.

MobileNumber
object
string | null

Address line 1. Street, PO Box, Company name e.g. "1 Smith St"

string | null

Address line 2. Apartment or unit number, suite, building number.

string | null

A neighbourhood or residental area containing the customer's primary location.

string | null

Suburb of the customer's primary location.

string | null

State or territory of the customer's primary location.

string | null

Post code or ZIP code.

date | null

Date and time the customer joined the merchant e.g. datecreated={ddMMyyyy}

boolean | null

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.

CustomFields
array of objects | null
CustomFields
Responses

Updated 7 months ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago