Skip to main content

Customer Details Response

Customer details including profile, payment account, payment option, and merchant information.

account object

Customer Payment account.

bankAccount object

Customer bank account details.

accountNamestringrequired

Account Holder name.

Constraints: <= 32 characters, Value must match regular expression [\u0020-\u007E]*

accountNumberstringrequired

Bank Account number.

Format: Value must match regular expression ^([0-9]{4,10})

bankBranchstring

Bank branch.

Max length: <= 50 characters

bankNamestring

Bank Name.

Max length: <= 50 characters

bsbstringrequired

BSB Number. Format: 000000.

Max length: <= 6 characters

isPayToboolean

Bank account is PayTo if true.

labelstring

Label for the account.

Max length: <= 50 characters

payToStatusinteger<int32>

If PayTo account, this field will let you know the status of the Mandate.

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

creditCard object

Customer credit card details.

cardNumberstring

Card number.

cardTypestring

Card Type.

expirystring

Expiry.

labelstring

Label for the card.

merchantCodestring

Merchant code.

merchantNamestring

Merchant trading name.

paymentOption object

Customer payment option.

bPayDetail object

BPAY details.

billerCodestring

BPAY Biller Code.

billerReferencestring

BPAY Biller Reference.

nextPaymentDatestring<date-time>required

Payment start date.

notificationMethodinteger<int32>required

Notification method used to indicate the communication channel when payment successful or failed.

Enum ValueDescription
0None
1Sms
2Email
payIdDetail object

PayID details.

payIdstring

PayID.

payIdNamestring

PayID Name.

referencestring

Reference.

paymentAmountnumber<double>required

Payment amount. Set the default amount for auto payments or amount for one-off payment.

paymentEndDatestring<date-time>

Payment end date.

paymentFrequencyinteger<int32>required

Payment frequency. Applicable to auto pay, email reminder and sms reminder. Returns monthly if frequency is not available.

Enum ValueDescription
32Weekly
33Fortnightly
34Quarterly
35HalfYearly
36Yearly
37FourWeeks
38Monthly
paymentOptioninteger<int32>required

Payment option. Use the correct payment option which is supported by the merchant.

Enum ValueDescription
22AutoPay
23EmailReminder
24SmsReminder
25FixedTerm
26BatchPay
27ScheduledPay
28OneOff
148PayID
149BPAY
profile object

Customer profile.

abnstring

Australian Business Number.

address object

Customer postal address.

address1stringrequired

Address line 1.

address2string

Address line 2.

countrystringrequired

Country.

Max length: <= 100 characters

postcodestringrequired

Postcode.

statestringrequired

State / province.

Max length: <= 50 characters

suburbstringrequired

Suburb / city.

Max length: <= 50 characters

bPayReferencestring

BPay reference number for the customer.

companyNamestring

Name of the customer company.

customerCodestring

Unique code assigned to the customer.

customerReferencestring

Unique reference identifier for the customer.

customerStatusstring

Current status of the customer account.

dateClosedstring<date-time>

Date the customer account was closed.

dateOfBirthstring<date-time>

Customer date of birth.

emailstring

Customer email address.

enableBPayOptionboolean

Whether BPay payment option is enabled for this customer.

faxstring

Customer fax number.

firstNamestring

Customer first name.

lastNamestring

Customer last name.

merchantStaffMemberstring

Staff member assigned to the customer.

mobilestring

Customer mobile phone number.

openDatestring<date-time>

Date the customer account was opened.

phonestring

Customer phone number.

titlestring

Customer title (e.g. Mr, Mrs, Ms).

Customer Details Response
{
  "account": {
    "bankAccount": {
      "accountName": "string",
      "accountNumber": "string",
      "bankBranch": "string",
      "bankName": "string",
      "bsb": "string",
      "isPayTo": true,
      "label": "string",
      "payToStatus": 0
    },
    "creditCard": {
      "cardNumber": "string",
      "cardType": "string",
      "expiry": "string",
      "label": "string"
    }
  },
  "merchantCode": "string",
  "merchantName": "string",
  "paymentOption": {
    "bPayDetail": {
      "billerCode": "string",
      "billerReference": "string"
    },
    "nextPaymentDate": "2024-07-29T15:51:28.071Z",
    "notificationMethod": 0,
    "payIdDetail": {
      "payId": "string",
      "payIdName": "string",
      "reference": "string"
    },
    "paymentAmount": 0,
    "paymentEndDate": "2024-07-29T15:51:28.071Z",
    "paymentFrequency": 32,
    "paymentOption": 22
  },
  "profile": {
    "abn": "string",
    "address": {
      "address1": "string",
      "address2": "string",
      "country": "string",
      "postcode": "string",
      "state": "string",
      "suburb": "string"
    },
    "bPayReference": "string",
    "companyName": "string",
    "customerCode": "string",
    "customerReference": "string",
    "customerStatus": "string",
    "dateClosed": "2024-07-29T15:51:28.071Z",
    "dateOfBirth": "2024-07-29T15:51:28.071Z",
    "email": "string",
    "enableBPayOption": true,
    "fax": "string",
    "firstName": "string",
    "lastName": "string",
    "merchantStaffMember": "string",
    "mobile": "string",
    "openDate": "2024-07-29T15:51:28.071Z",
    "phone": "string",
    "title": "string"
  }
}