5.1.3 "readAccountBalance" interface: Difference between revisions

From CBI GLOBE Wiki
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
5.1.3 ““readAccountBalance”” interface


Reads account data from a given account addressed by the account-id identifier.
Reads account data from a given account addressed by the account-id identifier.
Line 20: Line 19:
|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.
|-
|'''tpp-role'''
|The third party payment service provider can have one or more of the following roles:
-AISP (Account Information Service Provider)<br>
-PISP (Payment Initiation Service Provider)<br>
-PIISP (Payment Instrument Issuing Service Provider)
|-
|'''aspsp-code'''
|The account servicing payment service provider code
|-
|-
|'''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.
|-
|'''tpp-registration-number'''
|The third party payment service provider can have one or more of the following roles:
AISP (Account Information Service Provider)
PISP (Payment Initiation Service Provider)
PIISP (Payment Instrument Issuing Service Provider)
|-
|-
|'''account-id'''
|'''account-id'''
Line 49: Line 33:
|-
|-
|'''Result Code'''
|'''Result Code'''
|Result of the payment initiation request.
|Result of the read account balance.
|-
|-
|'''Error Management'''
|'''Error Management'''
Line 60: Line 44:
|The list of balances amount details.
|The list of balances amount details.
|}
|}
----
<div class="prevpage">
[[5.1.2 "readAccountDetails" interface|<< 5.1.2 "readAccountDetails" interface]]
</div><div class="nextpage">
[[5.1.4 "readAccountTransactionList" interface|5.1.4 "readAccountTransactionList" interface >>]]
</div>

Latest revision as of 16:55, 14 March 2019

Reads account data from a given account addressed by the account-id 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.
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 balance.
Error Management Object identifying the error.
accounts Payment account details.
balances The list of balances amount details.

<< 5.1.2 "readAccountDetails" interface

5.1.4 "readAccountTransactionList" interface >>

Retrieved from "https://www.cbiglobe.com/Wiki/index.php?title=5.1.3_%22readAccountBalance%22_interface&oldid=525"