PagedVirtualAccountResponse

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 [

idstringrequired

id of the virtual account

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

clientIdstringrequired

ID of the client to which the beneficiary belongs

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

currencyCodestringnullablerequired

Three letters currency code,null for Multi-currency account

Example: AUD

accountNamestringrequired

Bank account name

Example: ABC Pty Ltd

bankNamestringrequired

Bank name

Example: Bank Of America

bankTypeBankTypesrequired

Bank type

Possible values: [SWIFT, LOCAL]

Example: LOCAL

bankCountryCodestringrequired

ISO 3166-1 alpha-2 country code

Example: AU

bankAddress objectrequired

Bank address

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

routingNoTypeRoutingNoTypes

Routing type

Possible values: [ABA, ACH, BIC, BSB, Fedwire, IBAN, IFSC, Branch Code, Routing Code, Sort Code, SWIFT, SWIFT/BIC, Routing Number, CNAPS, BANK CODE, None, Transit Number]

Example: BSB

accountNumberstringrequired

Bank account number

Example: 999000123

routingNumberstringnullable

Routing number

Example: 012999

payIdstringnullable

PayID

Example: abc@abc.com

statusVirtualAccountStatusesrequired

Status of the virtual account

Possible values: [ACTIVE, INACTIVE]

Example: ACTIVE

createdTimestringrequired

The creation time of the virtual account

Example: 2024-12-12T09:44:00.312Z

]

PagedVirtualAccountResponse

{
  "meta": {
    "skip": 0,
    "limit": 10,
    "totalCount": 100,
    "timestamp": "2024-07-29T15:51:28.071Z"
  },
  "data": [
    {
      "id": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "clientId": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "currencyCode": "AUD",
      "accountName": "ABC Pty Ltd",
      "bankName": "Bank Of America",
      "bankType": "LOCAL",
      "bankCountryCode": "AU",
      "bankAddress": {
        "street": "19 Victoria Ave",
        "city": "Sydney",
        "state": "New South Wales",
        "zip": "2000"
      },
      "routingNoType": "BSB",
      "accountNumber": "999000123",
      "routingNumber": "012999",
      "payId": "abc@abc.com",
      "status": "ACTIVE",
      "createdTime": "2024-12-12T09:44:00.312Z"
    }
  ]
}