Search Customer Accounts

Search the customer accounts for a given customer

SecurityoAuth2

Request

path Parameters

customerUID

required

string

Customer unique identifier assigned by the system

query Parameters

page	string Which number of page of results to be returned and the default value is '1' Example: page=1
limit	string <= 1000 Total number of records to be returned for a given page and the default value is '10' Example: limit=100

Request Body schema: application/json

Account Info

accountNumber	string Unique account number assigned by the bank.
accountType	string Type of the account. Typically Deposit or Loan. Enum: "Deposit" "Loan"
accountSubType	string Subtype of the account. Enum: "Checking" "Savings" "Health Savings Account" "CD" "Money Market" "Pseudo" "Credit Card" "Heloc" "Line of Credit"
currency	string ISO 4217 currency code for the account.
costCenter	string Cost center to which the account is mapped.
status	string Current status of the account. Enum: "Active" "Inactive" "Closed" "Pending"
wireEnabled	boolean Whether wire transfers are enabled for this account.
fedNowEnabled	boolean Whether FedNow transfers are enabled for this account.
rtpEnabled	boolean Whether RTP (Real-Time Payments) are enabled.
swiftEnabled	boolean Whether SWIFT transfers are enabled.
fedwireEnabled	boolean Whether Fedwire transfers are enabled.

Responses

200

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

post/v3/customers/{customerUID}/accounts/search

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"accountNumber": "2136565",
"accountType": "Loan",
"accountSubType": "Heloc",
"currency": "USD",
"costCenter": "Global",
"status": "Active",
"wireEnabled": true,
"fedNowEnabled": true,
"rtpEnabled": true,
"swiftEnabled": false,
"fedwireEnabled": true
}

Response samples

application/json

{"pagination": {"totalRecords": 100,
"returnedRecords": 10,
"pageReturned": 2,
"pageSize": 10
},
"data": [{"accountType": "Deposit",
"accountSubType": "Savings",
"accountNumber": "****0001",
"accountName": "usd savings acc",
"routingNumber": "123456789",
"currency": "USD",
"masterGl": "50651123",
"fboAccountNumber": "",
"costCenter": "Global",
"countryCode": "US",
"reason": "string",
"bankIdType": "NationalBankCode",
"systemOfRecords": "Finzly Core",
"externalAccount": "string",
"accountFeatures": {"rfpReceive": false,
"rfpSend": false,
"accountAnalysis": false,
"feeAccount": "false",
"returnAccount": "false",
"fedWireFeature": {"enableWire": true,
"callbackLimit": 980.99,
"enableCallbacks": true,
"enableInternationalWire": true,
"enableDomesticWire": true
},
"fedNowFeature": {"enableFedNow": false,
"fednowReceiveOnly": false,
"fednowSendOrReceive": false,
"fednowRfpSend": false,
"fednowRfpReceive": false
},
"rtpFeature": {"enableRtp": false,
"rtpReceiveOnly": false,
"rtpSendOrReceive": false,
"rtpRfpSend": false,
"rtpRfpReceive": false
},
"achFeature": {"enableOffset": false,
"defaultOffset": false,
"enableUnderWritten": true,
"debitExposureLimit": 989.33,
"creditExposureLimit": 100.33,
"enableAchPrefund": false,
"achCompanyId": "string",
"secCodes": ["WEB"
]
}
},
"additionalAttributes": [{"attributeName": "IsRequired",
"value": "true"
}
],
"balanceType": "string",
"ledgerBalance": 190000.55,
"availableBalance": 190000.55,
"availableBalanceStatus": "Available",
"amountPrecision": 2
}
]
}