5.1.8 "getConsentStatus" interface: Difference between revisions

From CBI GLOBE Wiki
(Creata pagina con "5.1.8 ““getConsentStatus”” interface This API check the status of an account information consent resource. '''Input parameters''' {|class="wikitable" ! style="text-...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
5.1.8 ““getConsentStatus”” interface


This API check the status of an account information consent resource.
This API check the status of an account information consent resource.
Line 11: Line 10:
|'''consent-id'''
|'''consent-id'''
|The consent identification assigned to the created resource.
|The consent identification assigned to the created resource.
|-
|'''tpp-registration-number'''
|A unique registration number for TPP identification
|-
|-
|'''tpp-signature-certificate'''
|'''tpp-signature-certificate'''
Line 27: Line 23:
request.
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)
PISP (Payment Initiation Service Provider)
PIISP (Payment Instrument Issuing Service Provider)
|-
|'''aspsp-code'''
|The account servicing payment service provider code
|}
|}


Line 64: Line 51:
|This data element is containing information about the status of the SCA method applied.
|This data element is containing information about the status of the SCA method applied.
|}
|}
----
<div class="prevpage">
[[5.1.7 "updateConsent" interface|<< 5.1.7 "updateConsent" interface]]
</div><div class="nextpage">
[[5.1.9 "getConsent" interface|5.1.9 "getConsent" interface >>]]
</div>

Latest revision as of 16:57, 14 March 2019

This API check the status of an account information consent resource.

Input parameters

Attribute Description
consent-id The consent identification assigned to the created resource.
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.

Output parameters

Attribute Description
Result Code Result of the get consent status.
Error Management Description of the type of error obtained in the event that the outcome is negative.
consentStatus Possible output values:

- received
- rejected
- valid
- revokedByPsu
- expired
- terminatedByTpp
- replaced
- invalidated
- pendingExpired

scaStatus This data element is containing information about the status of the SCA method applied.