This article shows how to lookup an account using a financial account number. Often, external users will have a financial account number, and will need to lookup the Eclipse Account ID to utilize other eclipse api endpoints which require an eclipse account id.
URL
GET http://test.orioneclipse.com/v1/account/accounts/simple?search=<financial_account_number>
| Parameter | Description | Required | Data type |
| search | String to search | Yes | string |
Response
Success 200
| Field | Type | Description |
|---|---|---|
| id | Number | System Generated Id. – Eclipse Account ID (used in other account endpoints) |
| name | String | Account Name. |
| accountId | String | Orion Connect Account Id. |
| accountNumber | String | Financial Account Number. |
| accountType | String | Account Type. |
| isDeleted | Boolean | This will always be false. |
| isSleeve | Boolean | Account is Sleeve or not in the system. |
| createdOn | Date | Account creation date into application. |
| createdBy | String | Id of user who created the Account into the system. |
| editedOn | Date | Account edited date into application. |
| editedBy | String | Id of user who edited the Account details into the system. |