Creating Sub-accounts

📘

What is a sub-account?

A sub-account is logical unit within your business that requires a different settlement account and different dashboard from other parts of the business, but sits contractually and from a risk and compliance perspective entirely within the arrangements with Azupay.

It's recommended to review the Account Types and Client Management guide to understand what the multi-account pattern for direct merchants creating sub-accounts.

To create a sub-account, issue the following API call:

POST https://api.azupay.com.au/v1/client/{clientId}/apiKey
Authorization: SECR_MYBUSINESSID_UNIQUEKEY
Content-Type: application/json

{
    "client": {
        "payIDDomains": [
            {
                "domain": "ourcompany.com.au"
            }
        ],
        "clientTransactionId": "30597959-a853-44d4-bdab-54332bf7a98e",
        "legalName": "Example merchant SubAccount",
        "tradingName": "Trading as Subaccount name",
        "defaultPaymentExpiryDuration": 3600,
        "abn": "12345678922",
        "settlementAccountBSB": "223456",
        "settlementAccountNumber": "223456789",
        "settlementPayID": "[email protected]",
        "settlementAccountFullLegalName": "Legal Bank Account for sub account"
    }
}

You will get a response like the following:

{
    "client": {
        "id": "735f30d9404b5d73c2bacf9624b4cbe1",
        "clientTransactionId": "30597959-a853-44d4-bdab-54332b345543",
        "legalName": "Example merchant sub-account",
        "tradingName": "Trading as sub-account name",
        "defaultPaymentExpiryDuration": 3600,
        "payIDDomains": [
            {
                "domain": "ourcompany.com.au"
            }
        ],
        "abn": "12345643922",
        "settlementAccountBSB": "223456",
        "settlementAccountNumber": "223456799",
        "settlementPayID": "[email protected]",
        "settlementAccountFullLegalName": "Legal Bank Account for sub account",
        "keys": [
            {
                "keyId": "SECR",
                "bcryptKeyHash": "$2a$10$ZrolqWhmhHy1OVco38ld3eLV./Qz/Zd.b0Og7pltVDjoixbJt8OWO",
                "key": "SECR_735f30d9404b5d73c2bacf9624b4cbe1_A1Y1LxdLarVkMD03"
            }
        ]
    }
}

Note: sending in values in the KYC object is not required when creating sub-accounts. At minimum you only need to add values for required fields in the API request when creating a sub-account.

Now let's break down what you have submitted!

Sub-account Client Information

This is mandatory information we require to create a sub-account

• clientTransactionId: This is your unique identifier for the sub-account. We recommend using a Universally Unique Identifier (UUID).
• legalName:: This is legally registered name of your business
• tradingName: This is the name by which customers know your business
• abn: The Australian Business Number for your business

PayID configurations

In the Clients API Request, you can configure some of the PayID configurations.

• defaultPaymentExpiryDuration: You can apply a default time based limit on your PaymentRequests by specifying a point in time in the future. In this example, it is set to 3600 minutes. This will be the default for Payment Requests, if you provide the paymentExpiryDatetime in the Payment Request API, it will override the defaultPaymentExpiryDuration set in the Clients API.
• payIDDomains: You can assign a custom Organisation or Merchant name specific domains that would reflect in the payment description
  • domain: The domain portion of the PayID, appears after the payID prefix and it must be a domain that you own. We will verify ownership of this domain during onboarding.

Settlement Details

In the Clients API Request, you can provide all of the settlement information. These are the details of your sub-accounts bank account in which they will receive the funds processed from payment requests.

• settlementAccountBSB: The BSB of the client's bank account where funds will be settled into
• settlementAccountNumber: The Account Number of the client's bank account where funds will be settled into
• settlementPayID: The client's PayID linked to their bank account. Some business banking accounts may offer a PayID. This is the preferred settlement method, as the funds will be available in your client's bank account in real time.
• settlementAccountFullLegalName: The full legal account name that is attached to the client's bank account.