Name for the account. Only letters, numbers, and spaces are allowed.
accountNumber
required
string <= 255 characters
User bank account number.
accountType
required
string <= 45 characters
Bank account type.
Enum:"Deposit""Loan"
accountSubType
required
string <= 50 characters
Bank account sub type.
Enum:"Checking""Savings""Health Savings Account""CD""Money Market""Pseudo""Credit Card""Heloc""Line of Credit""MoneyMarket (Deprecated, use Money Market)""LineofCredit (Deprecated, use Line of Credit)"
currency
required
string <= 255 characters
Account currency. Currency Code is ISO format.
countryCode
required
string <= 10 characters
ISO country code.
costCenter
string <= 100 characters
Cost Center associated with the customer entity
enableOffset
string
Enable offset account. Possible values are 'Yes','No'
enableWire
string
Enable or Disable for the wire transaction. The default value is 'Yes' Possible values are 'Yes','No'
defaultOffset
string
Default offset account.Possible values are 'Yes','No'
feeAccount
string
Whether the accountNumber is a Fee account. Possible values are 'Yes','No'
returnAccount
string
Whether the accountNumber is a Return account. Possible values are 'Yes','No'
fboAccountNumber
string <= 255 characters
The fbo account number should be associated with legal entity.
systemOfRecords
required
string <= 50 characters
System of records.
Enum:"Other Core""External"
routingNumber
required
string <= 255 characters
Valid routing number/bankId
masterGl
required
string <= 100 characters
Master gl.
reason
string <= 255 characters
Note
isUnderWritten
boolean
To allow UnderWritten for the account. It is an optional field. The Possible values are true/false.
isAchPrefund
boolean
ACH Prefunding is a practice that ensures the account has sufficient funds for ACH Credit payments. It is an optional field. The Possible values are true/false.
debitExposureLimit
number <double> >= 0
Maximum allowed amount for debit transfers for prefunded ACH accounts. Must be a positive value.
creditExposureLimit
number <double> >= 0
Maximum allowed amount for credit transfers for prefunded ACH accounts. Must be a positive value.
bankIdType
string <= 50 characters
Bank identifier type
Enum:"NID""BIC"
accountAnalysis
boolean
Account analysis. It is an optional field. The Possible values are true/false.
callbackLimit
number <double>
Call back limit.
enableCallbacks
boolean
Enable call backs. It is an optional field. The Possible values are true/false.
secCodes
Array of strings
Provide all valid SEC-Standard Entry Class codes allowed for the given customer entity. e.g. WEB,CCD,PPD,TEL,IAT, etc..
achCompanyId
string <= 10 characters
ACH company ID is a 10-digit identifier used by banks and Nacha, the operator of the ACH network, to identify the entity collecting payments or sending money via ACH (also referred to as an “originator”)
object (AccountFeatures)
Array of objects (AdditionalAttribute)
An optional list of additional account attributes.
Responses
200
OK
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
default
Successful
post/v2/customers/{customerUID}/accounts
Request samples
Payload
curl
JavaScript
Node.js
application/json
{
"accountName": "xyz 123",
"accountNumber": "2136565",
"accountType": "Deposit",
"accountSubType": "Checking",
"currency": "USD",
"countryCode": "US",
"costCenter": "5235666",
"enableOffset": "Yes",
"enableWire": "Yes",
"defaultOffset": "Yes",
"feeAccount": "Yes",
"returnAccount": "Yes",
"fboAccountNumber": "string",
"systemOfRecords": "Other Core",
"routingNumber": "101206101",
"masterGl": "9898965",
"reason": "Notes",
"isUnderWritten": false,
"isAchPrefund": false,
"debitExposureLimit": 1000,
"creditExposureLimit": 5000,
"bankIdType": "NID",
"accountAnalysis": false,
"callbackLimit": 1000,
"enableCallbacks": false,
"secCodes": [
"WEB"
],
"achCompanyId": "1234567899",
"accountFeatures": {
"rfpReceive": true,
"rfpSend": true
},
"additionalAttributes": [
{
"attributeName": "SourceReferenceId",
"value": "7c40d833-6dfe-454a-bdea-0d6098c12c61"
}
]
}
Response samples
200
500
default
application/json
{
"status": "Success",
"code": "ACC001",
"message": "Failed to create an account: <Reason>",