Skip to main content

ConnectionState

The connection state represents a the current status of the connection including timestamps of things that have occurred

statusConnectionStateEnum

The current state of the connection.

Enum ValueDescription
ABANDONEDThe connection has not been activated.
ACTIVEThe connection is authorised and can be used to access data.
CANCELLEDThe connection has been cancelled, before a dataholder has been selected.
DECLINEDThe customer declined the authorisation request, after a dataholder has been selected.
DISCONNECTEDThe customer has revoked an active connection.
EXPIREDThe connection authorisation has expired.
INITIATEDThe connection has been created but authorisation has not yet been completed.
LOGOUTThe authorisation journey ended because the customer logged out.

Possible values: [INITIATED, ABANDONED, CANCELLED, DECLINED, DISCONNECTED, ACTIVE, EXPIRED, LOGOUT]

connectedAtstring<date-time>
disconnectedAtstring<date-time>
BANK_ACCOUNT object
statusExtractionStateEnum

Possible values: [SUCCESS, FAILURE]

referenceIdstring
lastSuccessstring<date-time>
lastUpdatedstring<date-time>
BANK_BALANCE object
statusExtractionStateEnum

Possible values: [SUCCESS, FAILURE]

referenceIdstring
lastSuccessstring<date-time>
lastUpdatedstring<date-time>
BANK_TRANSACTION object
statusExtractionStateEnum

Possible values: [SUCCESS, FAILURE]

referenceIdstring
lastSuccessstring<date-time>
lastUpdatedstring<date-time>
USER_INFO object
statusExtractionStateEnum

Possible values: [SUCCESS, FAILURE]

referenceIdstring
lastSuccessstring<date-time>
lastUpdatedstring<date-time>
ConnectionState
{
"status": "INITIATED",
"connectedAt": "2024-07-29T15:51:28.071Z",
"disconnectedAt": "2024-07-29T15:51:28.071Z",
"BANK_ACCOUNT": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"BANK_BALANCE": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"BANK_TRANSACTION": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
},
"USER_INFO": {
"status": "SUCCESS",
"referenceId": "string",
"lastSuccess": "2024-07-29T15:51:28.071Z",
"lastUpdated": "2024-07-29T15:51:28.071Z"
}
}