Create customer account

Create a customer account

SecurityoAuth2
Request
path Parameters
customerUID
required
integer

Unique Customer Id

Request Body schema: application/json
required

Account Info

accountName
required
string <= 255 characters

Name for the account. Only letters, numbers, and spaces are allowed.

accountNumber
required
string <= 255 characters

User bank account number.

accountType
required
string

Bank account type.

Enum: "Deposit" "Loan"
accountSubType
required
string

Bank account sub type.

Enum: "Checking" "Savings" "Health Savings Account" "CD" "Money Market" "Pseudo" "Credit Card" "Heloc" "Line of Credit" "MoneyMarket" "LineofCredit"
currency
required
string = 3 characters

Account currency. Currency Code is ISO format.

countryCode
required
string <= 10 characters

ISO country code.

costCenter
string <= 25 characters

Cost Center associated with the customer entity.

enableOffset
string

Enable offset account. Possible values are 'Yes','No'

fboAccountNumber
string <= 255 characters

The For-Benefit-Of (FBO) account number associated with a legal entity. This field is required when the accountSubType is set to "Pseudo".

systemOfRecords
required
string

System of records where the account is maintained.

Enum: "Other Core" "External"
routingNumber
required
string <= 255 characters

Valid routing number / bankId.

masterGl
required
string <= 100 characters

Master GL number for accounting purposes.

reason
string <= 255 characters

Optional note or reason for account creation.

bankIdType
string

Type of bank identifier.

Enum: "NID" "BIC"
object (V3CreateAccountRequest_accountFeatures)

Account-level feature toggles and capabilities.

Array of objects (V3CreateAccountRequest_additionalAttributes)

List of additional key-value attributes configured for the account.

Responses
201

Created

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

post/v3/customers/{customerUID}/accounts
Request samples
application/json
{
  • "accountName": "xyz 123",
  • "accountNumber": "2136565",
  • "accountType": "Deposit",
  • "accountSubType": "Checking",
  • "currency": "USD",
  • "countryCode": "US",
  • "costCenter": "5235666",
  • "enableOffset": "Yes",
  • "fboAccountNumber": "string",
  • "systemOfRecords": "Other Core",
  • "routingNumber": "101206101",
  • "masterGl": "9898965",
  • "reason": "Notes",
  • "bankIdType": "NID",
  • "accountFeatures": {
    },
  • "additionalAttributes": [
    ]
}
Response samples
application/json
{
  • "code": "SUCCESS",
  • "message": "Bank account created successfully",
  • "data": {
    }
}