4.2.4 "getPeriodicPaymentRequest" interface
4.2.4 “getPeriodicPaymentRequest” interface
This API returns the content of a payment object.
Input parameters
| Attribute | Description |
|---|---|
| psu-id | The ID of the PSU in the ASPSP client interface. Mandatory if “psu-corporate-id” is valorized. |
| psu-id-type | Type of the PSU-ID, needed in scenarios where PSUs have several PSU-IDs as access possibility. |
| psu-corporate-id-type | Identification of a Corporate, only used in a corporate context. |
| consent-id | This data element may be contained, if the payment initiation transaction is part of a session, i.e. combined AIS/PIS service. This then contains the “consentId” of the related AIS consent, which was performed prior to this payment initiation. |
| 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 the account servicing payment service provider. |
| 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. |
| 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 |
| payment-product | The addressed payment product endpoint.
The value list of products supported is:
- sepa-credit-transfers |
| payment-id | Resource Identification of the related payment initiation. |
Output parameters
| Attribute | Description |
|---|---|
| Result Code | Result of the get periodic payment request. |
| Error Management | Description of the type of error obtained in the event that the outcome is negative. |
| debtorAccount | The account identification which can be used on payload-level to address specific accounts. |
| instructedAmount | Transaction amount to be checked within the funds check mechanism. |
| creditorAccount | The account identification which can be used on payload-level to address specific accounts. |
| transactionStatus | Accepted values:
- ACCP |
