Portals

patch

https://app.financekey.com/OData/Portals({key})

A portal defines the online platform provided by a bank or financial institutions that allows account holders to manage their accounts online.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

portalId

string

required

length between 1 and 128

The PortalId field is an nvarchar data type with a maximum length of 128 characters and is used as a primary key in the Portal table. It is used as a unique identifier for each row and ensures that each Portal record is uniquely identified.

description

string

required

length between 1 and 512

The field 'Description' in the 'Portal' table will be of data type nvarchar and willbe able to contain up to 512 characters of text. It can be used to store a general description of the record associated with the Portal.

comment

string | null

Miscellaneous notes and information for the entry or record.

systemDefnId

int32

SystemDefnId is an int field in the Portal table that serves as a unique identifier for each system definition created or added to the Portal database. Each record will have its own SystemDefnId to reference, allowing for efficient organization and system management.

portalReconciliationStrategyId

string

required

length between 1 and 32

The PortalReconciliationStrategyId is an nvarchar field with a maximum length of 32 in the Portal table that uniquely identifies the reconciliation strategy for each portal, if applicable.

portalSupportEmail

string | null

The PortalSupportEmail field in the Portal table is of data type nvarchar and has a maximum length of 96. It stores the email address of the support team that is responsible for providing assistance for the Portal.

url

string | null

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!