Last updated 10 months ago
Was this helpful?
Perform various operations on external account records.
Symitar eDocs References: Coming soon.
The authorization object required for the operation. Only one credential type is required (if multiple are available) as long as it is configured in SymXchange parameters.
{"UserNumberCredentials":{"UserNumber":1995,"Password":"2dfKQYR!TeXJwe"}}
The custom object for NexumAPI request attributes.
{"customFields":{"appId":"glaci"}}
POST /nexum/627/2022.01/account/getExternalAccount HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 189 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "ExternalAccountLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
Successful operation.
{ "ExternalAccount": { "AcctType": 1, "CreationDate": "2025-05-19", "ExpirationDate": "2025-05-19", "FinancialInstitutionName": "text", "Locator": 1, "Number": "text", "PreNoteSentDate": "2025-05-19", "PrimaryAccountHolderName": "text", "RecordChangeDate": "2025-05-19", "Rt": "text", "Status": 1 } }
POST /nexum/627/2022.01/account/getExternalAccountSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 497 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "ExternalAccountLocator": 1, "SelectableFields": { "IncludeAllExternalAccountFields": true, "ExternalAccountFields": { "AcctType": true, "CreationDate": true, "ExpirationDate": true, "FinancialInstitutionName": true, "Locator": true, "Number": true, "PreNoteSentDate": true, "PrimaryAccountHolderName": true, "RecordChangeDate": true, "Rt": true, "Status": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/getExternalAccountPagedList HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 256 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ExternalAccount": [ { "AcctType": 1, "CreationDate": "2025-05-19", "ExpirationDate": "2025-05-19", "FinancialInstitutionName": "text", "Locator": 1, "Number": "text", "PreNoteSentDate": "2025-05-19", "PrimaryAccountHolderName": "text", "RecordChangeDate": "2025-05-19", "Rt": "text", "Status": 1 } ], "Token": "text" }
POST /nexum/627/2022.01/account/getExternalAccountListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 470 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "SelectableFields": { "IncludeAllExternalAccountFields": true, "ExternalAccountFields": { "AcctType": true, "CreationDate": true, "ExpirationDate": true, "FinancialInstitutionName": true, "Locator": true, "Number": true, "PreNoteSentDate": true, "PrimaryAccountHolderName": true, "RecordChangeDate": true, "Rt": true, "Status": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ExternalAccountList": { "hasReachedMaximumListSize": true, "ExternalAccount": [ { "AcctType": 1, "CreationDate": "2025-05-19", "ExpirationDate": "2025-05-19", "FinancialInstitutionName": "text", "Locator": 1, "Number": "text", "PreNoteSentDate": "2025-05-19", "PrimaryAccountHolderName": "text", "RecordChangeDate": "2025-05-19", "Rt": "text", "Status": 1 } ] } }
POST /nexum/627/2022.01/account/searchExternalAccountSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 502 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "SelectableFields": { "IncludeAllExternalAccountFields": true, "ExternalAccountFields": { "AcctType": true, "CreationDate": true, "ExpirationDate": true, "FinancialInstitutionName": true, "Locator": true, "Number": true, "PreNoteSentDate": true, "PrimaryAccountHolderName": true, "RecordChangeDate": true, "Rt": true, "Status": true } }, "SearchFilter": { "Query": "text" }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/getExternalAccountPagedListSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 564 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllExternalAccountFields": true, "ExternalAccountFields": { "AcctType": true, "CreationDate": true, "ExpirationDate": true, "FinancialInstitutionName": true, "Locator": true, "Number": true, "PreNoteSentDate": true, "PrimaryAccountHolderName": true, "RecordChangeDate": true, "Rt": true, "Status": true } }, "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/searchExternalAccountPagedSelectFields HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 579 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "PagingRequestContext": { "NumberOfRecordsToReturn": 1, "NumberOfRecordsToSkip": 1, "Token": "text" }, "SelectableFields": { "IncludeAllExternalAccountFields": true, "ExternalAccountFields": { "AcctType": true, "CreationDate": true, "ExpirationDate": true, "FinancialInstitutionName": true, "Locator": true, "Number": true, "PreNoteSentDate": true, "PrimaryAccountHolderName": true, "RecordChangeDate": true, "Rt": true, "Status": true } }, "Query": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
POST /nexum/627/2022.01/account/updateExternalAccountByID HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 402 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "ExternalAccountLocator": 1, "ExternalAccountUpdatableFields": { "AcctType": 1, "CreationDate": "2025-05-19", "ExpirationDate": "2025-05-19", "FinancialInstitutionName": "text", "Number": "text", "PrimaryAccountHolderName": "text", "Rt": "text", "Status": 1 }, "AccountNumber": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "UpdateStatus": { "isAllFieldsUpdateSuccess": true, "FailedUpdateStatus": [ { "Record": "text", "ErrorCode": "text", "ErrorMessage": "text", "PrimaryKeyField": [ { "Name": "text", "Value": "text" } ] } ] } }
POST /nexum/627/2022.01/account/createExternalAccount HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 375 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "ExternalAccountCreatableFields": { "AcctType": 1, "CreationDate": "2025-05-19", "ExpirationDate": "2025-05-19", "FinancialInstitutionName": "text", "Number": "text", "PrimaryAccountHolderName": "text", "Rt": "text", "Status": 1 }, "AccountNumber": "text", "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "ExternalAccountLocator": 1 }
POST /nexum/627/2022.01/account/deleteExternalAccount HTTP/1.1 Host: naas.ymcu.libum.io Authorization: Bearer JWT Content-Type: application/json Accept: */* Content-Length: 189 { "Credentials": { "UserNumberCredentials": { "UserNumber": 1995, "Password": "2dfKQYR!TeXJwe" } }, "AccountNumber": "text", "ExternalAccountLocator": 1, "nxAttributes": { "customFields": { "appId": "glaci" } } }
{ "nxAttributes": {} }
