5.1.1 "readAccountList" interface: Difference between revisions

From CBI GLOBE Wiki
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
4.2.4 ““readAccountList”” interface


Reads a list of ASPSP accounts, with balances where required. It is assumed that a consent of the Payment
Reads a list of ASPSP accounts, with balances where required. It is assumed that a consent of the Payment
Line 18: Line 17:
|-
|-
|'''signature'''
|'''signature'''
|A signature of the request by the TPP on application level. This might be mandated by the account servicing payment service provider.
|A signature of the request by the TPP on application level. This might be mandated by ASPSP.
|-
|-
|'''digest'''
|'''digest'''
|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)
|-
|'''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)
|-
|-
|'''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.
|-
|'''aspsp-code'''
|The account servicing payment service provider code
|-
|-
|'''with_balance'''
|'''with_balance'''
Line 52: Line 36:
|-
|-
|'''Result Code'''
|'''Result Code'''
|Result of the payment initiation request.
|Result of the read account list.
|-
|-
|'''Error Management'''
|'''Error Management'''
|Description of the type of error obtained in the event that the outcome is negative.
|Object identifying the error.
|-
|-
|'''Accounts'''
|'''accounts'''
|Array of account detail objects. At least a parameter is required.
|Array of account detail objects. At least a parameter is required.
|}
|}
----
<div class="prevpage">
[[5.1 Account Information Services|<< 5.1 Account Information Services]]
</div><div class="nextpage">
[[5.1.2 "readAccountDetails" interface|5.1.2 "readAccountDetails" interface >>]]
</div>

Latest revision as of 16:54, 14 March 2019

Reads a list of ASPSP accounts, with balances where required. It is assumed that a consent of the Payment Service User to this access is already given and stored on the Account Servicing Payment Service Provider system. The addressed list of accounts depends then on the Payment Service User identifier and 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.

Output parameters

Attribute Description
Result Code Result of the read account list.
Error Management Object identifying the error.
accounts Array of account detail objects. At least a parameter is required.

<< 5.1 Account Information Services

5.1.2 "readAccountDetails" interface >>

Retrieved from "https://www.cbiglobe.com/Wiki/index.php?title=5.1.1_%22readAccountList%22_interface&oldid=523"