Create internal account

Use case

Here we will review how to set up an bank technical account - internal account.

Use case data	API parameters with values
Internal account type	"accountTypeCode": "INTERNAL"
The name of the account holder is Trevor Harry Tuum	"personName": "Trevor Harry Tuum"
For the internal accounts, use the internal customer group	"customerGroupCode": "INTERNAL"
For the internal accounts, use the internal pricelist	"priceListTypeCode": "INTERNAL"
Trevor's residency country is the Great Britain	"residencyCountryCode": "GB"
The internal account currency is euro	"currencyCode": "EUR"

Sample API call

To create an internal account, make the following API call.

https://account-api.sandbox.tuumplatform.com/api/v4/persons/{personId}/accounts

See more about the create account endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call for creating an internal account.

JSON

{
  "accountTypeCode": "INTERNAL",
  "personName": "Trevor Harry Tuum",
  "residencyCountryCode": "GB",
  "customerGroupCode": "INTERNAL",
  "priceListTypeCode": "INTERNAL",
  "currencyCode": "EUR"
}

cURL

curl -L 'https://account-api.sandbox.tuumplatform.com/api/v4/persons/ID-3392/accounts' \
-H 'x-channel-code: system' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMjZUMTM6NTc6MDAiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODc3ODc4MjB9.dLFGW9A1MvRHNAhjFr_yXBm0m24bHI0NlIARuiwbBqE' \
-d '{
  "accountTypeCode": "INTERNAL",
  "personName": "Trevor Harry Tuum",
  "residencyCountryCode": "GB",
  "customerGroupCode": "INTERNAL",
  "priceListTypeCode": "INTERNAL",
  "currencyCode": "EUR"
}'

Sample response

Below you find an example response body to the API call above.

Response

{
    "errors": null,
    "validationErrors": null,
    "data": {
        "accountId": "ID-1282",
        "personId": "ID-3392",
        "accountTypeCode": "INTERNAL",
        "activationDate": "2023-06-26",
        "accountName": null,
        "personName": "Trevor Harry Tuum",
        "statusCode": "ACTIVE",
        "iban": "XX54XXXX99999000000000000001257",
        "bic": "ICECLOUDXXX",
        "defaultCurrencyCode": "EUR",
        "tenantCode": "MB",
        "residencyCode": "GB",
        "customerGroupCode": "INTERNAL",
        "personTypeCode": null,
        "intraOrgCode": null,
        "accountTypeSetupCode": "STANDARD",
        "serviceProviderCode": "TUUM",
        "interestMethodAssignmentCode": null,
        "accountClassCode": null,
        "balances": [
            {
                "balanceId": "ID-1209",
                "accountId": "ID-1282",
                "currencyCode": "EUR",
                "balanceAmount": 0,
                "reservedAmount": 0,
                "overdraftLimitAmount": 0,
                "defaultCurrencyCode": "EUR",
                "availableBalanceInDefaultCcy": 0,
                "negativeBalanceStartDate": null,
                "availableBalanceAmount": 0
            }
        ],
        "masterAccountId": null,
        "accountNumbers": [],
        "taxResidencyCountryCode": "GB",
        "jurisdictionCountryCode": "GB"
    }
}

Result

The outcome of the API call is the complete set of account data. Including the parameters generated by the Tuum system:

Parameter and value	Explanation
accountId": "ID-1282	A unique identifier is assigned to the new account.
"statusCode": "ACTIVE"	The new account is created and activated.
"iban": "XX54XXXX99999000000000000001257"	The IBAN assigned to the new account.
"bic": "ICECLOUDXXX"	The BIC assigned to the new account.