5.1.2 "readAccountDetails" interface: Difference between revisions
From CBI GLOBE Wiki
No edit summary |
No edit summary |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
Reads details about an account, with balances where required. It is assumed that a consent of the PSU to | Reads details about an account, with balances where required. It is assumed that a consent of the PSU to | ||
Line 22: | Line 21: | ||
|Is contained if and only if the “Signature” element is contained in the header of the request. | |Is contained if and only if the “Signature” element is contained in the header of the request. | ||
The “digest” Header contains a Hash of the message body. The only hash algorithms that may be used to calculate the digest within the context of this specification are SHA-256 and SHA-512. | The “digest” Header contains a Hash of the message body. The only hash algorithms that may be used to calculate the digest within the context of this specification are SHA-256 and SHA-512. | ||
|- | |- | ||
|'''consent-id''' | |'''consent-id''' | ||
|The identifier of the consent resource authorizing the operation to perform. | |The identifier of the consent resource authorizing the operation to perform. | ||
|- | |- | ||
|'''with_balance''' | |'''with_balance''' | ||
|If contained, this function reads the list of accessible payment accounts including the booking balance. This call will be rejected if the parameter is used in a case, where the access right on balances is not granted in the related consent or if the ASPSP does not support the with_balance parameter. | |If contained, this function reads the list of accessible payment accounts including the booking balance. This call will be rejected if the parameter is used in a case, where the access right on balances is not granted in the related consent or if the ASPSP does not support the with_balance parameter. | ||
|- | |||
|'''account-id''' | |'''account-id''' | ||
|This identification is denoting the addressed account. The account-id is the UUID related to the account structure. Its value is constant at least throughout the lifecycle of a given consent. | |This identification is denoting the addressed account. The account-id is the UUID related to the account structure. Its value is constant at least throughout the lifecycle of a given consent. | ||
Line 53: | Line 38: | ||
|- | |- | ||
|'''Result Code''' | |'''Result Code''' | ||
|Result of the | |Result of the read account details. | ||
|- | |- | ||
|'''Error Management''' | |'''Error Management''' | ||
Line 61: | Line 46: | ||
|Payment account details. | |Payment account details. | ||
|} | |} | ||
---- | |||
<div class="prevpage"> | |||
[[5.1.1 "readAccountList" interface|<< 5.1.1 "readAccountList" interface]] | |||
</div><div class="nextpage"> | |||
[[5.1.3 "readAccountBalance" interface|5.1.3 "readAccountBalance" interface >>]] | |||
</div> |
Latest revision as of 16:54, 14 March 2019
Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends on the stored consent addressed by the consent identifier.
Input parameters
Attribute | Description |
---|---|
tpp-signature-certificate | This is a X509 certificate that the TPP uses for signing the request, in base64 encoding.
This certificate is in PEM format without the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----". Must be contained if a signature is contained, see above. |
signature | A signature of the request by the TPP on application level. This might be mandated by ASPSP. |
digest | Is contained if and only if the “Signature” element is contained in the header of the request.
The “digest” Header contains a Hash of the message body. The only hash algorithms that may be used to calculate the digest within the context of this specification are SHA-256 and SHA-512. |
consent-id | The identifier of the consent resource authorizing the operation to perform. |
with_balance | If contained, this function reads the list of accessible payment accounts including the booking balance. This call will be rejected if the parameter is used in a case, where the access right on balances is not granted in the related consent or if the ASPSP does not support the with_balance parameter. |
account-id | This identification is denoting the addressed account. The account-id is the UUID related to the account structure. Its value is constant at least throughout the lifecycle of a given consent. |
Output parameters
Attribute | Description |
---|---|
Result Code | Result of the read account details. |
Error Management | Object identifying the error. |
accounts | Payment account details. |