ClientObj

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azupay/main/json-schema/azupay-client-obj-schema.json",
  "title": "ClientObj",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/azupay-clients-api-openapi.yml#/components/schemas/ClientObj",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "client"
  ],
  "properties": {
    "client": {
      "type": "object",
      "description": "The client",
      "additionalProperties": false,
      "required": [
        "clientTransactionId",
        "legalName",
        "defaultPaymentExpiryDuration",
        "payIDDomains",
        "abn",
        "settlementAccountFullLegalName"
      ],
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true,
          "description": "The unique id for the new client. This client is created using the `clientTransactionId` so the client\nwill be replaced if the same value is sent which will return the same value for `id`.\n\nIt is recommended to record this id for later use.\n"
        },
        "clientTransactionId": {
          "type": "string",
          "maxLength": 36,
          "description": "This field is used to prevent the creation of duplicated clients in case of a message retry. It is\nrecommended that a unique id (like uuid) is used for each client. If the same value is used a second time\nthe client will be replaced.\n"
        },
        "legalName": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The client legal name.\n"
        },
        "tradingName": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "pattern": "^[a-zA-Z0-9\\-_ ]*$",
          "description": "The client trading name.\n"
        },
        "additionalTradingNames": {
          "$ref": "#/$defs/AdditionalTradingNamesObj"
        },
        "defaultPaymentExpiryDuration": {
          "type": "number",
          "minimum": 60,
          "description": "The default expiry duration of a `PaymentRequest` in **minutes**.\n"
        },
        "payIDDomains": {
          "$ref": "#/$defs/PayIDDomainsObj"
        },
        "abn": {
          "type": "string",
          "minLength": 11,
          "maxLength": 11,
          "pattern": "^\\d*$",
          "description": "The Australian Business Number for the client.\n"
        },
        "settlementAccountBSB": {
          "type": "string",
          "minLength": 6,
          "maxLength": 6,
          "pattern": "^\\d*$",
          "description": "The BSB of the account used to sweep collected funds for this client.\n\nIt has to be provided if `settlementAccountNumber` is provided.\n"
        },
        "settlementAccountNumber": {
          "type": "string",
          "minLength": 5,
          "maxLength": 9,
          "pattern": "^\\d*$",
          "description": "The Account Number (without the BSB) used to sweep collected funds for this client. By default funds\nwill be swept every day.\n\nIt has to be provided if `settlementAccountBSB` is provided.\n"
        },
        "settlementPayID": {
          "type": "string",
          "format": "email",
          "description": "Fill if the client funds are to be swept to a PayID instead of a BSB and Account Number. If provided both\n`settlementAccountBSB` and `settlementAccountNumber` will be ignored and this will be used.\n"
        },
        "settlementAccountFullLegalName": {
          "type": "string",
          "maxLength": 50,
          "minLength": 1,
          "description": "The legal name that is attached to the client's account.\n"
        },
        "sweepNotification": {
          "type": "object",
          "additionalProperties": false,
          "description": "Populate this object if you would like Azupay to send a sweep notification webhook when Azupay settles\nto your account.\n",
          "required": [
            "authorizationHeader",
            "url"
          ],
          "properties": {
            "url": {
              "type": "string",
              "pattern": "^https://",
              "description": "Provide a https endpoint accessible over the internet\n"
            },
            "authorizationHeader": {
              "type": "string",
              "description": "The value you want populated in the Authorization request header when Azupay calls the endpoint specified in the `url` field.\n"
            }
          }
        },
        "clientManagementNotification": {
          "type": "object",
          "description": "Populate this object if you would like Azupay to send a notification webhook when the sub-merchant account is enabled.\n",
          "additionalProperties": false,
          "required": [
            "url",
            "authorizationHeader"
          ],
          "properties": {
            "url": {
              "type": "string",
              "pattern": "^https://",
              "description": "Provide a https endpoint accessible over the internet\n"
            },
            "authorizationHeader": {
              "type": "string",
              "description": "The value you want populated in the Authorization request header when Azupay calls the endpoint specified in the `url` field.\n"
            }
          }
        },
        "topUpPayId": {
          "type": "string",
          "format": "email",
          "description": "The payID that can be used to topup the balance for the newly created client. This is a read only field\nonly provided in the response.\n",
          "readOnly": true
        },
        "dashboardUserEmail": {
          "type": "string",
          "format": "email",
          "description": "If provided, this email will receive a message with a temporary \npassword to sign-in to the dashboard as an admin user. If the user is already exists and has not accepted\nchanged the password, it will resend the invite. Else if the user has an account and is attached to a\ndifferent clientId, the request will fail.\n"
        },
        "dashboardUserRole": {
          "type": "string",
          "description": "The role for the dashboard user, if not supplied it will be defaulted to `ADMIN`. \nNote `FINANCE_WRITE` has been deprecated and replaced by `FINANCE_ADMIN`.\n",
          "enum": [
            "ADMIN",
            "FINANCE_WRITE",
            "FINANCE_ADMIN"
          ]
        },
        "transactionPayoutLimit": {
          "type": "string",
          "pattern": "^[0-9]+(\\.[0-9]{2})$",
          "description": "Defines the maximum amount (in AUD) for a single outbound payment that the client is allowed to process."
        },
        "dailyTransactionPayoutLimit": {
          "type": "string",
          "pattern": "^[0-9]+(\\.[0-9]{2})$",
          "description": "Defines the maximum amount (in AUD) for the total value of outbound payments that the client is allowed to process within a single day."
        },
        "kyc": {
          "type": "object",
          "additionalProperties": false,
          "description": "KYC check object. *This property may be mandatory for some clients",
          "required": [
            "businessRegistrationDate",
            "businessContactName",
            "businessEmailAddress",
            "businessPhoneNumber",
            "businessRegisteredAddress",
            "completion",
            "websiteURL"
          ],
          "properties": {
            "businessRegistrationDate": {
              "type": "string",
              "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$"
            },
            "businessContactName": {
              "type": "string",
              "maxLength": 100,
              "minLength": 1
            },
            "businessEmailAddress": {
              "type": "string",
              "minLength": 1,
              "maxLength": 2048,
              "pattern": "^(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)$"
            },
            "businessPhoneNumber": {
              "type": "string",
              "pattern": "^\\+[0-9]{1,3}-[1-9]{1,1}[0-9]{1,29}$"
            },
            "businessRegisteredAddress": {
              "type": "string",
              "maxLength": 255,
              "minLength": 10,
              "pattern": "^[A-Za-z0-9\\s,.-]+$"
            },
            "completion": {
              "type": "boolean"
            },
            "websiteURL": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255,
              "pattern": "^https?:\\/\\/([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\/?$"
            },
            "instagramURL": {
              "type": "string",
              "pattern": "^https?:\\/\\/([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\/?$"
            },
            "facebookURL": {
              "type": "string",
              "pattern": "^https?:\\/\\/([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\/?$"
            },
            "linkedInProfileURL": {
              "type": "string",
              "pattern": "^https?:\\/\\/([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\/?$"
            },
            "acn": {
              "type": "string",
              "minLength": 9,
              "maxLength": 9,
              "pattern": "^\\d{9}$",
              "description": "Australian Company Number (ACN) must be provided if merchant is a registered company."
            },
            "companyIncorporationDate": {
              "type": "string",
              "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
              "description": "Company Incorporation Date must be provided if ACN is provided"
            },
            "afslNumber": {
              "type": "string",
              "minLength": 1,
              "maxLength": 9,
              "pattern": "^\\d{1,9}$"
            },
            "merchantCategoryCode": {
              "$ref": "#/$defs/MerchantCodeEnumObj"
            }
          }
        },
        "keys": {
          "type": "array",
          "readOnly": true,
          "description": "These are the API keys generated once the client is created. Keep in a secure place.\n",
          "items": {
            "type": "object",
            "required": [
              "keyId",
              "bcryptKeyHash"
            ],
            "properties": {
              "keyId": {
                "type": "string",
                "description": "Unique identifier for the key"
              },
              "bcryptKeyHash": {
                "type": "string",
                "description": "The one way hash for the key."
              },
              "key": {
                "type": "string",
                "readOnly": true,
                "description": "The actual value used on the `Authorization` header for the API."
              }
            }
          }
        }
      }
    }
  },
  "$defs": {
    "AdditionalTradingNamesObj": {
      "type": "array",
      "minItems": 1,
      "maxItems": 20,
      "items": {
        "type": "string",
        "maxLength": 140,
        "minLength": 1,
        "pattern": "^[a-zA-Z0-9\\-_ ]*$"
      },
      "description": "Additional trading names"
    },
    "MerchantCodeEnumObj": {
      "type": "string",
      "enum": [
        7623,
        8931,
        7311,
        763,
        4511,
        4582,
        4119,
        7996,
        5937,
        5932,
        7998,
        8911,
        5971,
        5970,
        7531,
        7535,
        7538,
        5531,
        6011,
        5542,
        8675,
        5533,
        5532,
        9223,
        5462,
        7929,
        7230,
        7995,
        5940,
        7932,
        5551,
        4457,
        5942,
        5192,
        7933,
        4131,
        8244,
        7278,
        4899,
        5946,
        5441,
        7512,
        7542,
        5511,
        5521,
        1750,
        7217,
        5811,
        8398,
        5169,
        8351,
        5641,
        8049,
        8041,
        5993,
        8641,
        7349,
        7296,
        8220,
        5046,
        5139,
        7333,
        4111,
        4816,
        7372,
        7379,
        5734,
        5045,
        1771,
        5039,
        7392,
        8241,
        5977,
        7277,
        7997,
        4215,
        9211,
        7321,
        4411,
        5451,
        7911,
        7273,
        8021,
        5311,
        7393,
        5815,
        5817,
        5816,
        5818,
        5964,
        5965,
        5967,
        5960,
        5969,
        5966,
        5968,
        5962,
        5310,
        8011,
        5963,
        5714,
        5813,
        5912,
        5122,
        7216,
        5099,
        5309,
        5812,
        8299,
        5997,
        5552,
        5065,
        1731,
        7622,
        5732,
        8211,
        9702,
        7361,
        7394,
        7342,
        5651,
        5814,
        6012,
        9222,
        5718,
        5713,
        5992,
        5193,
        5422,
        5983,
        7261,
        7641,
        5712,
        5681,
        1520,
        5947,
        5231,
        5950,
        7992,
        7801,
        9399,
        7802,
        9406,
        7800,
        5411,
        5251,
        5072,
        7298,
        5975,
        1711,
        5945,
        5200,
        8062,
        7011,
        5722,
        5085,
        7375,
        6399,
        6300,
        9950,
        5944,
        780,
        7211,
        7210,
        8111,
        5948,
        5211,
        6010,
        4468,
        5262,
        1740,
        7297,
        8099,
        8071,
        5047,
        8699,
        5611,
        5691,
        5051,
        5699,
        5599,
        7399,
        5499,
        5399,
        7299,
        5719,
        2741,
        7999,
        7699,
        5999,
        5271,
        7832,
        4214,
        5592,
        5013,
        5571,
        5561,
        5733,
        5994,
        6051,
        6052,
        6053,
        6054,
        6055,
        6056,
        6057,
        6058,
        6059,
        6060,
        6061,
        6062,
        6063,
        6064,
        6065,
        6066,
        6540,
        5199,
        5261,
        8050,
        5021,
        8043,
        8042,
        5976,
        8031,
        5921,
        5198,
        7523,
        4112,
        5933,
        5995,
        5172,
        7395,
        7221,
        5044,
        7829,
        5131,
        5074,
        8651,
        9402,
        5094,
        8999,
        4225,
        7338,
        4011,
        6513,
        5735,
        7519,
        5973,
        8661,
        6530,
        1761,
        7339,
        6211,
        5541,
        5949,
        7251,
        5661,
        7629,
        5598,
        1799,
        2842,
        5941,
        7032,
        7941,
        5655,
        5972,
        5111,
        5943,
        5996,
        4723,
        5697,
        9311,
        7276,
        4121,
        4812,
        4814,
        4821,
        5998,
        8734,
        7922,
        7012,
        7534,
        4784,
        7991,
        7549,
        7033,
        4789,
        4722,
        7511,
        7513,
        2791,
        5978,
        9405,
        5137,
        5931,
        4900,
        5331,
        742,
        7993,
        7994,
        7841,
        8249,
        7631,
        7692,
        5300,
        5698,
        4829,
        5631,
        5621,
        5935
      ]
    },
    "PayIDDomainsObj": {
      "type": "array",
      "description": "A list of domain names that can be use for payIDs. Optionally use `merchantName` to control the payID\ndescription prefix.\n",
      "minItems": 1,
      "maxItems": 10,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "domain"
        ],
        "properties": {
          "domain": {
            "type": "string",
            "description": "The domain name for the PayID",
            "pattern": "^\\b((?=[a-z0-9-]{1,63}\\.)[a-z0-9]+(-[a-z0-9]+)*\\.)+[a-z]{2,63}\\b$"
          },
          "merchantName": {
            "type": "string",
            "description": "This name will appear as a prefix for the PayID description that the payer sees",
            "maxLength": 50
          }
        }
      }
    }
  }
}