OpenFinance
Development Portal

Consent API for V2.x (2.1)

The Berlin Group - A European Standards Initiative | info@: info@berlin-group.org | URL: https://www.berlin-group.org/

License: Creative Commons Attribution 4.0 International Public License

Create, retrieve, and cancel the consents a PSU grants for account information and confirmation of funds. A consent records which data the TPP may access, how long the access lasts, and how often it can be used, and it moves through a defined set of statuses over its lifecycle.

Get funds consent

GET /v2/consents/funds-confirmations/{consentId}

Reads the content of a consent object regarding confirmation of funds access.

Parameter Type Description
consentId string , required

ID of the corresponding consent object as returned by an account information consent request.

Example: Text, maximum of 70 characters.

Allowed length: max: 70

Header Type Description
Digest string , optional

Integrity hash of the request body in the form SHA-256=<base64>. For an empty body, use the hash of an empty string. See Signing requests for how the Digest and signature are built.

Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=

x-jws-signature string , optional

Detached JSON Web Signature over the signed request headers and body. See Signing requests for how it is constructed.

X-Request-ID string , required

Unique ID of the request, set by the initiating party and echoed back in the response.

Example: 99391c7e-ad88-49ec-a2ad-99ddcb1f7721

Format: uuid

Select a status code to see the structure and an example of the response.

Field Type Description
access oneOf , required

The payment accounts the consent grants access to. See Consent types for how consent types differ.

cardNumber string , optional

Card Number of the card issued by the PIISP. Should be delivered if available.

consentType string , required

See document "openFinance API Framework Data Dictionary", section "Consent Type Code" for more details.

Allowed values: global, detailed, aspspManaged, accountList

consentStatus string , required

Status of the consent. Statuses are described in Consent statuses.

Allowed values: received, rejected, partiallyAuthorised, valid, revokedByPsu, expired, terminatedByTpp, replacedByTpp

cardExpiryDate string , optional

Expiry date of the card issued by the PIISP

Format: date

cardInformation string , optional

Additional explanation for the card product.

registrationInformation string , optional

Additional registration information.