ExternalAccount

Perform various operations on external account records.

Symitar eDocs References: Coming soon.

Operations

getExternalAccount

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

ExternalAccountLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getExternalAccount

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getExternalAccount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "ExternalAccountLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": {
    "AcctType": 1,
    "CreationDate": "2025-12-25",
    "ExpirationDate": "2025-12-25",
    "FinancialInstitutionName": "text",
    "Locator": 1,
    "Number": "text",
    "PreNoteSentDate": "2025-12-25",
    "PrimaryAccountHolderName": "text",
    "RecordChangeDate": "2025-12-25",
    "Rt": "text",
    "Status": 1
  }
}

getExternalAccountSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

ExternalAccountLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/getExternalAccountSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getExternalAccountSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": {
    "AcctType": 1,
    "CreationDate": "2025-12-25",
    "ExpirationDate": "2025-12-25",
    "FinancialInstitutionName": "text",
    "Locator": 1,
    "Number": "text",
    "PreNoteSentDate": "2025-12-25",
    "PrimaryAccountHolderName": "text",
    "RecordChangeDate": "2025-12-25",
    "Rt": "text",
    "Status": 1
  }
}

getExternalAccountPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getExternalAccountPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getExternalAccountPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [
    {
      "AcctType": 1,
      "CreationDate": "2025-12-25",
      "ExpirationDate": "2025-12-25",
      "FinancialInstitutionName": "text",
      "Locator": 1,
      "Number": "text",
      "PreNoteSentDate": "2025-12-25",
      "PrimaryAccountHolderName": "text",
      "RecordChangeDate": "2025-12-25",
      "Rt": "text",
      "Status": 1
    }
  ],
  "Token": "text"
}

getExternalAccountListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getExternalAccountListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getExternalAccountListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountList": {
    "hasReachedMaximumListSize": true,
    "ExternalAccount": [
      {
        "AcctType": 1,
        "CreationDate": "2025-12-25",
        "ExpirationDate": "2025-12-25",
        "FinancialInstitutionName": "text",
        "Locator": 1,
        "Number": "text",
        "PreNoteSentDate": "2025-12-25",
        "PrimaryAccountHolderName": "text",
        "RecordChangeDate": "2025-12-25",
        "Rt": "text",
        "Status": 1
      }
    ]
  }
}

searchExternalAccountSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/searchExternalAccountSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchExternalAccountSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountList": {
    "hasReachedMaximumListSize": true,
    "ExternalAccount": [
      {
        "AcctType": 1,
        "CreationDate": "2025-12-25",
        "ExpirationDate": "2025-12-25",
        "FinancialInstitutionName": "text",
        "Locator": 1,
        "Number": "text",
        "PreNoteSentDate": "2025-12-25",
        "PrimaryAccountHolderName": "text",
        "RecordChangeDate": "2025-12-25",
        "Rt": "text",
        "Status": 1
      }
    ]
  }
}

getExternalAccountPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/getExternalAccountPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/getExternalAccountPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [
    {
      "AcctType": 1,
      "CreationDate": "2025-12-25",
      "ExpirationDate": "2025-12-25",
      "FinancialInstitutionName": "text",
      "Locator": 1,
      "Number": "text",
      "PreNoteSentDate": "2025-12-25",
      "PrimaryAccountHolderName": "text",
      "RecordChangeDate": "2025-12-25",
      "Rt": "text",
      "Status": 1
    }
  ],
  "Token": "text"
}

searchExternalAccountPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchExternalAccountPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/searchExternalAccountPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
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"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [
    {
      "AcctType": 1,
      "CreationDate": "2025-12-25",
      "ExpirationDate": "2025-12-25",
      "FinancialInstitutionName": "text",
      "Locator": 1,
      "Number": "text",
      "PreNoteSentDate": "2025-12-25",
      "PrimaryAccountHolderName": "text",
      "RecordChangeDate": "2025-12-25",
      "Rt": "text",
      "Status": 1
    }
  ],
  "Token": "text"
}

updateExternalAccountByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ExternalAccountLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/updateExternalAccountByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/updateExternalAccountByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 402

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "ExternalAccountLocator": 1,
  "ExternalAccountUpdatableFields": {
    "AcctType": 1,
    "CreationDate": "2025-12-25",
    "ExpirationDate": "2025-12-25",
    "FinancialInstitutionName": "text",
    "Number": "text",
    "PrimaryAccountHolderName": "text",
    "Rt": "text",
    "Status": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

createExternalAccount

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

post

/createExternalAccount

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/createExternalAccount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "ExternalAccountCreatableFields": {
    "AcctType": 1,
    "CreationDate": "2025-12-25",
    "ExpirationDate": "2025-12-25",
    "FinancialInstitutionName": "text",
    "Number": "text",
    "PrimaryAccountHolderName": "text",
    "Rt": "text",
    "Status": 1
  },
  "AccountNumber": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountLocator": 1
}

deleteExternalAccount

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

ExternalAccountLocatorintegerOptional

Responses

200

Successful operation.

application/json

post

/deleteExternalAccount

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/account/deleteExternalAccount HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "AccountNumber": "text",
  "ExternalAccountLocator": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}