PagedBusinessClientResponse

meta objectrequired

meta data

skipnumber

number of skip records

Default value: 0

Example: 0

limitnumber

number of maximum return records

Default value: 10

Example: 10

totalCountnumberrequired

total number of records

Example: 100

timestampstring<date-time>required

the time of the query result

data object[]required

records

Array [

countryCodestringrequired

ISO 3166-1 alpha-2 country code

Example: AU

address objectrequired

streetstring

Business official street address. Allowed characters: letters, digits, spaces and , . - / # ( ) : '

Possible values: >= 4 characters and <= 256 characters, Value must match regular expression ^[A-Za-z0-9\s,.\-/#():']+$

Example: 19 Victoria Ave

citystring

City name of business official address. Allowed characters: letters, spaces and - . '

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z\s\-.']+$

Example: Sydney

statestring

State name of business official address. Allowed characters: letters, spaces and -

Possible values: <= 128 characters, Value must match regular expression ^[A-Za-z\s\-]+$

Example: New South Wales

zipstring

Zip code of business official address. Allowed characters: letters, digits, hyphens and spaces

Possible values: <= 32 characters, Value must match regular expression ^[A-Za-z0-9\- ]+$

Example: 2000

contactEmailstring

Business contact email

Example: contact@abc.website

referenceIdstring<^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,35}$>

The unique reference id of this entity creation. Optional, but highly recommended to use. When given, it fails the creation if a duplicate entity is found. Only alphanumeric characters, underscores and hyphens are allowed, and cannot start with a hyphen.

Possible values: <= 36 characters

Example: 1234567890

notestring

Note

Example: Manual onboard

transactionContinuationstring

Indicates whether the client’s expected transactions are one-off or ongoing/recurring (used for onboarding/KYC expected transaction profile).

Possible values: [ONEOFF, ONGOING]

Example: ONEOFF

expectedAnnualTransactionAmountnumber

Expected annual transaction amount (applicable when transactionContinuation is ONGOING).

Example: 100000

expectedAnnualTransactionCountnumber

Expected annual transaction count (applicable when transactionContinuation is ONGOING).

Example: 10

namestringrequired

Client name. Allowed characters: letters, digits, spaces and / & - . , ' +

Possible values: <= 256 characters, Value must match regular expression ^[a-zA-Z0-9/&.,'\- +]+$

Example: ABC Pty Ltd

tradingNamestringrequired

Trading name. Allowed characters: letters, digits, spaces and / & - . , ' +

Possible values: <= 128 characters, Value must match regular expression ^[a-zA-Z0-9/&.,'\- +]+$

Example: ACB Pty Ltd

businessTypestringrequired

Business type. Allowed characters: letters, digits, spaces and -

Possible values: <= 128 characters, Value must match regular expression ^[a-zA-Z0-9 \-]+$

Example: Australian Proprietary Company

businessNaturestring

Business nature

Possible values: <= 128 characters

Example: IT consulting services

businessPhonestring<E.164>

Business phone number

Example: +612...

businessNumberstringrequired

Government business number, ABN for Australian businesses (11 digits)

Possible values: <= 32 characters

Example: 66655577888

companyNumberstring

Government company number, ACN for Australian companies (9 digits)

Example: 655577888

contactNumberstring

Business contact number

Example: +61266668888

registerDatestring

Registration date of the business

Example: 2020-07-01

beneficiaryOwnerFirstNamestringrequired

Beneficiary owner first name. Allowed characters: letters, spaces, apostrophes and hyphens

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z '\-]+$

Example: John

beneficiaryOwnerLastNamestringrequired

Beneficiary owner last name. Allowed characters: letters, spaces, apostrophes and hyphens

Possible values: <= 32 characters, Value must match regular expression ^[a-zA-Z '\-]+$

Example: Doe

websitestring

Business official website address

Example: https://abc.website

idstringrequired

id of the client

Example: 401f4647-8372-495f-8de0-aafb3e1eaf93

clientNostringrequired

Human readable client unique No

Example: CAPAYAU-SYD-021233

uniquePayIdstringrequired

Unique CAPAY PAY ID which could be used for internal transfer

Example: 6244120284213583

isVerifiedbooleanrequireddeprecated

Whether the client is approved, this field will be deprecated soon, use status instead please

Example: true

statusClientStatusesrequired

Client status

Possible values: [PENDING APPROVAL, ACTIVE, INACTIVE, SUSPENDED]

Example: ACTIVE

createdTimestringrequired

The time when the client was created

Example: 2023-12-12T01:23:33Z

updatedTimestringrequired

The time when the client was last updated

Example: 2023-12-12T01:23:33Z

]

PagedBusinessClientResponse

{
  "meta": {
    "skip": 0,
    "limit": 10,
    "totalCount": 100,
    "timestamp": "2024-07-29T15:51:28.071Z"
  },
  "data": [
    {
      "countryCode": "AU",
      "address": {
        "street": "19 Victoria Ave",
        "city": "Sydney",
        "state": "New South Wales",
        "zip": "2000"
      },
      "contactEmail": "contact@abc.website",
      "referenceId": "1234567890",
      "note": "Manual onboard",
      "transactionContinuation": "ONEOFF",
      "expectedAnnualTransactionAmount": 100000,
      "expectedAnnualTransactionCount": 10,
      "name": "ABC Pty Ltd",
      "tradingName": "ACB Pty Ltd",
      "businessType": "Australian Proprietary Company",
      "businessNature": "IT consulting services",
      "businessPhone": "+612...",
      "businessNumber": "66655577888",
      "companyNumber": "655577888",
      "contactNumber": "+61266668888",
      "registerDate": "2020-07-01",
      "beneficiaryOwnerFirstName": "John",
      "beneficiaryOwnerLastName": "Doe",
      "website": "https://abc.website",
      "id": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "clientNo": "CAPAYAU-SYD-021233",
      "uniquePayId": "6244120284213583",
      "status": "ACTIVE",
      "createdTime": "2023-12-12T01:23:33Z",
      "updatedTime": "2023-12-12T01:23:33Z"
    }
  ]
}