New Customer Request
Customer creation request including profile, payment option, and account details.
Australian Business Number.
additionalPaymentAccountProxies object[]
Additional PaymentAccountProxies. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.
Label for the account.
Max length: <= 80 characters
Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.
Max length: <= 40 characters
additionalReferences object[]
Additional references if you have more than one references to manage. Eg: Parents paying childcare fee for more than one kid.
Customer reference linked to this additional reference.
Full name associated with the additional reference.
address object
Customer address.
Address line 1.
Address line 2.
Country.
Max length: <= 100 characters
Postcode.
State / province.
Max length: <= 50 characters
Suburb / city.
Max length: <= 50 characters
bankAccount object
Customer bank account details.
Account Holder name.
Constraints: <= 32 characters, Value must match regular expression [\u0020-\u007E]*
Bank Account number.
Format: Value must match regular expression ^([0-9]{4,10})
Bank branch.
Max length: <= 50 characters
Bank Name.
Max length: <= 50 characters
BSB Number. Format: 000000.
Max length: <= 6 characters
Bank account is PayTo if true.
Label for the account.
Max length: <= 50 characters
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]
card object
Customer credit / debit card proxy. (Token is generated using the /tokens api.
Card proxy generated by the /cardproxies api.
Max length: <= 40 characters
Label for the card.
Max length: <= 80 characters
Company name if this is company account.
Customer / Parent Reference. Should be unique and provided by the merchant. If you are paying the merchant by BPAY, this should be your BPAY Reference.
Date of birth. Customer must be atleast 16 years old.
Email address.
Allows to enable BPAY option for the customer / parent.
Fax number.
First name.
Max length: <= 30 characters
Send this as true when customer reference passed if CRN. Default is set to false if not passed.
Last name.
Max length: <= 30 characters
Merchant Staff member assigned to this customer / parent.
Mobile number.
Notification method used to indicate the communication channel when payment successful or failed.
| Enum Value | Description |
|---|---|
| 0 | None |
| 1 | Sms |
| 2 |
paymentAccountProxy object
This replaces the BankAccount and Card properties. Proxy is generated using the Payments Plugin for Bank and Credit/Debit Card or /cardProxies api for Credit/Debit Card.
Label for the account.
Max length: <= 80 characters
Card or bank account proxy. Proxy is generated using the Payments Plugin for bank account and card or /cardProxies api for card.
Max length: <= 40 characters
Payment amount. Set the default amount for auto payments or amount for one-off payment.
Payment end date.
Payment frequency. Applicable to auto pay, email reminder and sms reminder.
| Enum Value | Description |
|---|---|
| 32 | Weekly |
| 33 | Fortnightly |
| 34 | Quarterly |
| 35 | HalfYearly |
| 36 | Yearly |
| 37 | FourWeeks |
| 38 | Monthly |
Payment option. Use the correct payment option which is supported by the merchant.
| Enum Value | Description |
|---|---|
| 22 | AutoPay |
| 23 | EmailReminder |
| 24 | SmsReminder |
| 25 | FixedTerm |
| 26 | BatchPay |
| 27 | ScheduledPay |
| 28 | OneOff |
| 148 | PayID |
| 149 | BPAY |
Payment start date.
Phone number.
Promotion code if any.
Sends welcome email if set to true. Default is set to true if not passed.
Provide the salutation. Eg: Mr or Mrs.
Max length: <= 10 characters
Website URL if any.
{
"abn": "string",
"additionalPaymentAccountProxies": [
{
"label": "string",
"proxy": "string"
}
],
"additionalReferences": [
{
"customerReference": "string",
"fullName": "string"
}
],
"address": {
"address1": "string",
"address2": "string",
"country": "string",
"postcode": "string",
"state": "string",
"suburb": "string"
},
"bankAccount": {
"accountName": "string",
"accountNumber": "string",
"bankBranch": "string",
"bankName": "string",
"bsb": "string",
"isPayTo": true,
"label": "string",
"payToStatus": 0
},
"card": {
"cardProxy": "string",
"label": "string"
},
"customerCompanyName": "string",
"customerReference": "string",
"dateOfBirth": "2024-07-29T15:51:28.071Z",
"email": "string",
"enableBPayOption": true,
"fax": "string",
"firstName": "string",
"isBPayCrnPassed": true,
"lastName": "string",
"merchantStaffMember": "string",
"mobile": "string",
"notificationMethod": 0,
"paymentAccountProxy": {
"label": "string",
"proxy": "string"
},
"paymentAmount": 0,
"paymentEndDate": "2024-07-29T15:51:28.071Z",
"paymentFrequency": 32,
"paymentOption": 22,
"paymentStartDate": "2024-07-29T15:51:28.071Z",
"phone": "string",
"promotionCode": "string",
"sendWelcomeEmail": true,
"title": "string",
"websiteUrl": "string"
}