BusinessBeneficiaryCreate

countryCodestringrequired

ISO 3166-1 alpha-2 country code

Possible values: >= 2 characters and <= 2 characters

Example: AU

emailstring

Beneficiary email

Possible values: <= 128 characters

Example: contact@abc.com

phoneNumberstring<E.164>

Beneficiary phone number,E.164 formatted

Possible values: <= 32 characters

Example: +61299998888

address object

Beneficiary 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

uniquePayIdstring

CAPAY FastID if the beneficiary is a CAPAY client too (Either uniquePayId or bankAccount must be provided)

Possible values: <= 32 characters

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

nickNamestring

Nickname of the beneficiary. Allowed characters: letters, digits, spaces and / & - . , ' +

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

Example: ABC

namestringrequired

Name of the beneficiary. Allowed characters: letters, digits, spaces and / & - . , ' +

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

Example: ABC Pty Ltd

clientIdstring

Required if the beneficiary belongs to your client

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

bankAccount object

Beneficiary bank account (Either uniquePayId or bankAccount must be provided)

countryCodestringrequired

ISO 3166-1 alpha-2 country code

Possible values: >= 2 characters and <= 2 characters

Example: AU

bankTypeBankTypesrequired

Bank type

Possible values: [SWIFT, LOCAL]

Example: SWIFT

bankNamestringrequired

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

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

Example: Bank Of America

accountNamestringrequired

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

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

Example: ABC Pty Ltd

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

routingNumberstring

Routing number

Possible values: <= 64 characters

Example: 012999

routingNoType1RoutingNoTypes1

Extra routing type, Conditionally required: (1) 12 digits, CNAPS is required when Payment Type is 'OURS'. (2) 6 digits, Sort Code is required if the beneficiary bank is located in the UK, Guernsey, Isle of Man, or Jersey.

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: BANK CODE

routingNumber1string

Routing number for the extra routing type

Example: 012999

accountNumberstringrequired

Bank account number

Possible values: <= 64 characters

Example: 999000123

accountTypeBankAccountTypes

Bank account type

Possible values: [SAVINGS, CHECKING]

Example: SAVINGS

address object

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

currencyCodestringrequired

Three letters currency code

Possible values: >= 3 characters and <= 3 characters

Example: AUD

BusinessBeneficiaryCreate

{
  "countryCode": "AU",
  "email": "contact@abc.com",
  "phoneNumber": "+61299998888",
  "address": {
    "street": "19 Victoria Ave",
    "city": "Sydney",
    "state": "New South Wales",
    "zip": "2000"
  },
  "uniquePayId": "string",
  "referenceId": "1234567890",
  "nickName": "ABC",
  "name": "ABC Pty Ltd",
  "clientId": "401f4647-8372-495f-8de0-aafb3e1eaf93",
  "bankAccount": {
    "countryCode": "AU",
    "bankType": "SWIFT",
    "bankName": "Bank Of America",
    "accountName": "ABC Pty Ltd",
    "routingNoType": "BSB",
    "routingNumber": "012999",
    "routingNoType1": "BANK CODE",
    "routingNumber1": "012999",
    "accountNumber": "999000123",
    "accountType": "SAVINGS",
    "address": {
      "street": "19 Victoria Ave",
      "city": "Sydney",
      "state": "New South Wales",
      "zip": "2000"
    },
    "currencyCode": "AUD"
  }
}