Search
K
ob-account-and-transaction-api

Create Account Access Consents

post
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/account-access-consents

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Body

application/json; charset=utf-8

Default

OBReadConsent1

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

* Additional properties are NOT allowed.

Response

application/json; charset=utf-8

Account Access Consents Created

OBReadConsentResponse1

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

* Additional properties are NOT allowed.
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json; charset=utf-8

Get Account Access Consents

get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Path Parameters

ConsentIdstringrequired

ConsentId

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

application/json; charset=utf-8

Account Access Consents Read

OBReadConsentResponse1

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Riskobjectrequired

The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info.

* Additional properties are NOT allowed.
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json; charset=utf-8

Delete Account Access Consents

delete
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/account-access-consents/{ConsentId}

Path Parameters

ConsentIdstringrequired

ConsentId

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

Account Access Consents Deleted

 

Get Accounts

get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

application/json; charset=utf-8

Accounts Read

OBReadAccount3

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json; charset=utf-8

Get Accounts

get
https://https/mocking/api/v1/links/99d6f95a-22f3-4a33-85a1-256fa389e7d8/open-banking/v3.1/aisp/accounts/{AccountId}

Path Parameters

AccountIdstringrequired

AccountId

Headers

x-fapi-financial-idstringrequired

The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB.

x-fapi-customer-last-logged-timestring

The time when the PSU last logged in with the TPP.
All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below:
Sun, 10 Sep 2017 19:43:31 UTC

Match pattern:^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

x-fapi-customer-ip-addressstring

The PSU’s IP address if the PSU is currently logged in with the TPP.

x-fapi-interaction-idstring

An RFC4122 UID used as a correlation id.

Authorizationstringrequired

An Authorisation Token as per https://tools.ietf.org/html/rfc6750

x-customer-user-agentstring

Indicates the user-agent that the PSU is using.

Response

application/json; charset=utf-8

Accounts Read

OBReadAccount3

* Additional properties are NOT allowed.
Dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Linksobjectrequired

Links relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
Metaobjectrequired

Meta Data relevant to the payload

* Additional properties are NOT allowed.
Show Child Parameters
 
application/json; charset=utf-8