Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • POST /account-access-consents

3.1.1 UML Diagram

...

3.1.

...

  • The fields in the OBAccountAccessConsentRequest object are described in the Consent Elements section.

...

2 Data Dictionary

Name

Occurrence

XPath

Definition

Class/ Datatype

Codes

OBAccountAccessConsentRequest

 

OBAccountAccessConsentRequest

 

OBAccountAccessConsentRequest

 

Data

1..1

OBAccountAccessConsentRequest/Data

 

OBAccountAccessConsentRequest/Data

 

Permissions

1..n

OBAccountAccessConsentRequest/Data/Permissions

Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the User/Customer, and requested for authorisation with the ASPSP

String

Enum:

  • ReadAccountsBasic

  • ReadAccountsDetail

  • ReadBalances

  • ReadBeneficiariesBasic

  • ReadBeneficiariesDetail

  • ReadDirectDebits

  • ReadOffers

  • ReadPAN

  • ReadParty

  • ReadSupplementaryAccountInfo

  • ReadFutureDatedPaymentsBasic

  • ReadFutureDatedPaymentsDetail

  • ReadStandingOrdersBasi

  • ReadStandingOrdersDetail

  • ReadStatementsBasic

  • ReadStatementsDetail

  • ReadTransactionsBasic

  • ReadTransactionsCredits

  • ReadTransactionsDebits

  • ReadTransactionsDetail

TransactionFromDateTime

0..1

OBAccountAccessConsentRequest/Data/TransactionFromDateTime

Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction

DateTime

 

TransactionToDateTime

0..1

OBAccountAccessConsentRequest/Data/TransactionToDateTime

Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction

DateTime

 

...

{

  "Data": {

    "Permissions": [

      "ReadAccountsBasic"

    ],

    "TransactionFromDateTime": "2020-03-17T07:05:34.327+03:00",

    "TransactionToDateTime": "2020-0305-17T07:05:34.327+03:00"

  },

}

...

{

  "Data": {

    "ConsentId": "tbc-0083976",

    "CreationDateTime": "2020-0309-17T0710T19:0543:3431.508+03:00",

    "Status": "Authorised",

    "StatusUpdateDateTime": "2020-03-17T07:05:34.508+03:00",

    "Permissions": [

      "ReadAccountsBasic"

    ],

    "TransactionFromDateTime": "2020-03-17T07:05:34.508+03:00",

    "TransactionToDateTime": "2020-0305-17T07:05:34.508+03:00"

  },

  "Links": {

    "Self": "www.tbc.com"

  },

  "Meta": {

    "TotalPages": 1,

    "FirstAvailableDateTime": "2020-03-17T07:05:34.508+03:00",

    "LastAvailableDateTime": "2020-0305-17T07:05:34.508+03:00"

  }

}

...

{

  "Data": {

    "ConsentId": “0083976",

    "CreationDateTime": "2020-0309-17T0710T19:0543:3431.508+03:00",

    "Status": "Authorised",

    "StatusUpdateDateTime": "2020-03-17T07:05:34.508+03:00",

    "Permissions": [

      "ReadAccountsBasic"

    ],

    "TransactionFromDateTime": "2020-03-17T07:05:34.508+03:00",

    "TransactionToDateTime": "2020-0305-17T07:05:34.508+03:00"

  },

  "Links": {

    "Self": "www.tbc.com"

  },

  "Meta": {

    "TotalPages": 1,

    "FirstAvailableDateTime": "2020-03-17T07:05:34.508+03:00",

    "LastAvailableDateTime": "2020-0305-17T07:05:34.508+03:00"

  }

}

...

{

  "Data": {

    "ConsentId": "0083976",

    "CreationDateTime": "2020-0309-17T0710T19:0543:3431.508+03:00",

    "Status": "Revoked",

    "StatusUpdateDateTime": "2020-03-17T07:05:34.508+03:00",

    "Permissions": [

      "ReadAccountsBasic"

    ],

    "TransactionFromDateTime": "2020-03-17T07:05:34.508+03:00",

    "TransactionToDateTime": "2020-0305-17T07:05:34.508+03:00"

  },

  "Links": {

    "Self": "www.tbc.com"

  },

  "Meta": {

    "TotalPages": 1,

    "FirstAvailableDateTime": "2020-03-17T07:05:34.508+03:00",

    "LastAvailableDateTime": "2020-0305-17T07:05:34.508+03:00"

  }

}