4.2.2 "getPeriodicPaymentStatusRequest" interface

This API retrieves the status of a periodic payment initiated transaction.

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.

tpp-registration-number A unique registration number for TPP identification
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.

payment-product The addressed payment product endpoint.

The value list of products supported is: - sepa-credit-transfers - instant-sepa-credit-transfers - target-2-payments - cross-border-credit-transfers

payment-id Resource Identification of the related payment.

Output parameters

Attribute Description
Result Code Result of the get periodic payment status request.
Error Management Description of the type of error obtained in the event that the outcome is negative.
transactionStatus Accepted values:


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

This is free text but might be coded in a future version of the specification.

chosenScaMethod This data element is only contained in the response if the APSPS has chosen the Embedded SCA Approach, if the PSU is already identified.
scaMethods Might be contained, if several authentication methods are available. (name, type).