4.1.4 "getPaymentRequest" interface: Difference between revisions
From CBI GLOBE Wiki
(Creata pagina con "4.1.4 “getPaymentRequest” interface This API returns the content of a payment object. '''Input parameters''' {|class="wikitable" ! style="text-align:left;width:30%" | A...") |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This API returns the content of a payment object. | This API returns the content of a payment object. | ||
| Line 35: | Line 34: | ||
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. | ||
|- | |- | ||
|'''payment-product''' | |'''payment-product''' | ||
|The addressed payment product endpoint. | |The addressed payment product endpoint. | ||
The value list of products supported is: | The value list of products supported is: <br> | ||
- sepa-credit-transfers | - sepa-credit-transfers <br> | ||
- instant-sepa-credit-transfers | - instant-sepa-credit-transfers <br> | ||
- target-2-payments | - target-2-payments <br> | ||
- cross-border-credit-transfers | - cross-border-credit-transfers | ||
|- | |- | ||
|'''payment-id''' | |'''payment-id''' | ||
|Resource Identification of the | |Resource Identification of the corresponding payment initiation object. | ||
|} | |} | ||
| Line 64: | Line 54: | ||
|- | |- | ||
|'''Result Code''' | |'''Result Code''' | ||
|Result of the payment | |Result of the get payment request. | ||
|- | |- | ||
|'''Error Management''' | |'''Error Management''' | ||
| Line 80: | Line 70: | ||
|'''transactionStatus''' | |'''transactionStatus''' | ||
|Accepted values: | |Accepted values: | ||
- ACCP | - ACCP<br> | ||
- ACSC | - ACSC<br> | ||
- ACSP | - ACSP<br> | ||
- ACTC | - ACTC<br> | ||
- ACWC | - ACWC<br> | ||
- ACWP | - ACWP<br> | ||
- RCVD | - RCVD<br> | ||
- PDNG | - PDNG<br> | ||
- RJCT | - RJCT<br> | ||
|} | |} | ||
---- | |||
<div class="prevpage"> | |||
[[4.1.3 "updatePaymentResource" interface|<< 4.1.3 "updatePaymentResource" interface]] | |||
</div><div class="nextpage"> | |||
[[4.2 Periodic Payments|4.2 Periodic Payments >>]] | |||
</div> | |||
Latest revision as of 16:51, 14 March 2019
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 | This is describing the type of the identification needed by the ASPSP to identify the
PSU-Corporate-ID content. |
| 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. |
| payment-product | The addressed payment product endpoint.
The value list of products supported is: |
| payment-id | Resource Identification of the corresponding payment initiation object. |
Output parameters
| Attribute | Description |
|---|---|
| Result Code | Result of the get 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 |
