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: 215

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "ExternalAccountLocator": 282,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": {
    "Locator": 282,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getExternalAccount"
}

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: 275

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "ExternalAccountLocator": 282,
  "SelectableFields": {
    "IncludeAllExternalAccountFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": {
    "Locator": 282,
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getExternalAccountSelectFields"
}

getExternalAccountPagedList

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 265

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [],
  "Token": null,
  "MessageId": "getExternalAccountPagedList"
}

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: 246

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllExternalAccountFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountList": [],
  "MessageId": "getExternalAccountListSelectFields"
}

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: 287

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "SelectableFields": {
    "IncludeAllExternalAccountFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountList": [],
  "MessageId": "searchExternalAccountSelectFields"
}

getExternalAccountPagedListSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 477

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllExternalAccountFields": false,
    "ExternalAccountFields": {
      "Locator": true,
      "AcctType": true,
      "Number": true,
      "Rt": true,
      "FinancialInstitutionName": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [],
  "Token": null,
  "MessageId": "getExternalAccountPagedListSelectFields"
}

searchExternalAccountPagedSelectFields

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

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: 497

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013454",
  "Query": "LOCATOR=0",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllExternalAccountFields": false,
    "ExternalAccountFields": {
      "Locator": true,
      "AcctType": true,
      "Number": true,
      "Rt": true,
      "FinancialInstitutionName": true,
      "Status": true,
      "RecordChangeDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccount": [],
  "Token": null,
  "MessageId": "searchExternalAccountPagedSelectFields"
}

updateExternalAccountByID

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ExternalAccountLocatorintegerOptional

AccountNumberstringOptional

Responses

200

Successful operation.

application/jsonschema

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: 408

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "ExternalAccountLocator": 282,
  "ExternalAccountUpdatableFields": {
    "AcctType": 1,
    "Number": "99900001",
    "Rt": "111000025",
    "FinancialInstitutionName": "NEXUM TEST BANK UPDATED",
    "PrimaryAccountHolderName": "NEXUM WAVEFOUR",
    "Status": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateExternalAccountByID"
}

createExternalAccount

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

Responses

200

Successful operation.

application/jsonschema

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: 371

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "ExternalAccountCreatableFields": {
    "AcctType": 1,
    "Number": "99900001",
    "Rt": "111000025",
    "FinancialInstitutionName": "NEXUM TEST BANK",
    "PrimaryAccountHolderName": "NEXUM WAVEFOUR",
    "Status": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "ExternalAccountLocator": 282,
  "MessageId": "createExternalAccount"
}

deleteExternalAccount

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

AccountNumberstringOptional

ExternalAccountLocatorintegerOptional

Responses

200

Successful operation.

application/jsonschema

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: 215

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "AccountNumber": "0000013824",
  "ExternalAccountLocator": 282,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "MessageId": "deleteExternalAccount"
}