View source for 4.1.1 "paymentInitiationRequest" interface

4.1.1 “paymentInitiationRequest”

This API creates a payment resource with all data relevant for the corresponding payment product; each
payment product is managed by a dedicated endpoint. PSD2-Orchestrator publishes the payment-product
endpoint if at least one ASPSP support it.

'''Input parameters'''

{|class="wikitable"
! style="text-align:left;width:30%" | Attribute
! style="text-align:left;" | 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'''
|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-redirect-preferred'''
|Only “true” or “false” values are accepted.
If it equals “true”, the TPP prefers a redirect over an embedded SCA approach.
If it equals “false”, the TPP prefers not to be redirected for SCA.
The ASPSP will then choose between the Embedded or the Decoupled SCA approach, depending on the choice of the SCA procedure by the TPP/PSU. 
If the parameter is not used, the ASPSP will choose the SCA approach to be applied depending on the SCA method chosen by the TPP/PSU.
|-
|'''tpp-nok-redirect-uri'''
|If this URI is contained, the TPP is asking to redirect the transaction flow to this address instead of the TPP-Redirect-URI in case of a negative result of the redirect SCA method. This might be ignored by the ASPSP.
|-
|'''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'''
|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.
|-
|'''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
|-
|'''aspsp-product-code'''
|The account servicing payment service provider product code.
|-
|'''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
|-
|'''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.
|-
|'''transactionType'''
|Represents the payment method used
Possible values are:
- unattended_terminal_transaction (e.g. transportation or parking)
- cless_transaction
- remote_transaction
|}

'''Output parameters'''
{|class="wikitable"
! style="text-align:left;width:30%" | Attribute
! style="text-align:left;" | Description
|-
|'''Result Code'''
|Result of the payment initiation request.
|-
|'''Error Management'''
|Description of the type of error obtained in the event that the outcome is negative.
|-
|'''transactionStatus'''
|Accepted values:
- ACCP<br>
- ACSC<br>
- ACSP<br>
- ACTC<br>
- ACWC<br>
- ACWP<br>
- RCVD<br>
- PDNG<br>
- RJCT<br>
|-
|'''paymentId'''
|The UUID of the generated payment initiation resource.
|-
|'''scaMethods'''
|This data element might be contained, if SCA is required and if the PSU has a choice between different authentication methods.
If this data element is contained, then there is also an hyperlink of type
“selectAuthenticationMethods” contained in the response body.
These methods shall be presented towards the PSU for selection by the TPP.
|-
|'''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.
|}

----

<div class="prevpage">
[[4. Payments flow|<< 4. Payments flow]]
</div><div class="nextpage">
[[4.1.2 "getPaymentStatusRequest" interface|4.1.2 "getPaymentStatusRequest" interface >>]]
</div>