Update a Customer

put

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

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.

Updates the specified customer by setting the values of any parameters passed in the request body. For example, if you pass the Email parameter, the customers email will be updated to the new string.

If a parameter is not included in the request body, it will not be updated. This request accepts mostly the same parameters as the customer creation call with a few exceptions. The parameters used to update phone numbers are different from those used when creating a customer.

To generate a BPAY reference for an existing customer you will need to add ?with=bpayref to the end of the url your are posting to.

Pass the boolean parameter IsActive as false to set a customer as inactive. For a customer to be set to inactive they must have no on-going Direct Debit Requests or pending payments. If you wish to turn this customer on again later, set them active by changing this parameter to true.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

code

string

required

Body Params

IsConsumer

boolean | null

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.

ExternalID

string | null

The entities ID from the external system that created it.

Name

string | null

This attribute is used to store a business name against a customer. If the customer type is a "Consumer" do not use this attribute.

FirstName

string | null

First name of a customer, or the first name of a businesses primary contact.

LastName

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.

CustomRef

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.

DOB

date | null

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

Phone

string | null

Customers primary phone number. This string doesn't accept special characters. This is required to be a local number i.e. don't pass +61700000000 instead use 0700000000

PhoneCountryID

integer | null

The Country ID of a customers primary phone. The full list of Country ID's can be found at: Country ISO IDs.

HomePhone

string | null

Customers home phone number. This string doesn't accept special characters. This is required to be a local number i.e. don't pass +61700000000 instead use 0700000000

HomePhoneCountryID

integer | null

The Country ID of a customers home phone.The full list of Country ID's can be found at: Country ISO IDs.

Mobile

string | null

Customers mobile phone number. This string doesn't accept special characters. This is required to be a local number i.e. don't pass +61700000000 instead use 0700000000

MobileCountryID

integer | null

The Country ID of a customers mobile phone. The full list of Country ID's can be found at: Country ISO IDs.

Street1

string | null

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

Street2

string | null

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

SubLocality

string | null

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

Locality

string | null

Suburb of the customer's primary location.

AdministrativeArea

string | null

State or territory of the customer's primary location.

CountryId

integer | null

The Country ID of a customers address.The full list of Country ID's can be found at: Country ISO IDs.

Postcode

string | null

Post code or ZIP code.

SendDirectDebitErrorEmails

boolean | null

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.

SendPaymentReceiptEmails

boolean | null

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.

IsActive

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

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