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

externalReferenceId
required
string

Unique reference id from a system outside of finzly. The external reference id can be used by the finzly for the request tracing (if needed).

accountName
required
string

Name for the account

accountNumber
required
string

User bank account number.

accountType
required
string

Bank account type.

Enum: "Deposit" "Loan"
accountSubType
required
string

Bank account sub type.

Enum: "Checking" "Savings" "CD" "Money Market" "Pseudo" "HSA (Health Saving Account)"
currency
required
string

Account currency. Currency Code is ISO format.

countryCode
required
string

ISO country code.

costCenter
string

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

The fbo account number should be associated with legal entity.

systemOfRecords
required
string

System of records.

Enum: "Other Core" "External"
routingNumber
required
string

Valid routing number/bankId

masterGl
required
string

Master gl.

reason
string

Note

isUnderWritten
boolean

To allow UnderWritten for the account. It is an optional field. The Possible values are true/false.

debitExposureLimit
number

Debit exposure limit

creditExposureLimit
number

Credit exposure limit

bankIdType
string

Bank identifier type

Enum: "NID" "BIC"
accountAnalysis
boolean

Account analysis. It is an optional field. The Possible values are true/false.

callbackLimit
number

Call back limit.

enableCallbacks
boolean

Enable call backs. It is an optional field. The Possible values are true/false.

object (AccountFeatures)
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
application/json
{
  • "externalReferenceId": "REQ123",
  • "accountName": "xyz",
  • "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,
  • "debitExposureLimit": 1000,
  • "creditExposureLimit": 1000,
  • "bankIdType": "NID",
  • "accountAnalysis": false,
  • "callbackLimit": 1000,
  • "enableCallbacks": false,
  • "accountFeatures": {
    }
}
Response samples
application/json
{
  • "status": "Success",
  • "code": "ACC001",
  • "message": "Failed to create an account: <Reason>",
  • "data": {
    }
}