4.1.2 "getPaymentStatusRequest" interface: Difference between revisions
From CBI GLOBE Wiki
No edit summary |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This API retrieves the status of a payment initiated transaction. | This API retrieves the status of a payment initiated transaction. | ||
| Line 12: | Line 12: | ||
This certificate is in PEM format without the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----". | This certificate is in PEM format without the "-----BEGIN CERTIFICATE-----" and "-----END CERTIFICATE-----". | ||
Must be contained if a signature is contained, see above. | Must be contained if a signature is contained, see above. | ||
|- | |- | ||
|'''signature''' | |'''signature''' | ||
| Line 22: | Line 19: | ||
|Is contained if and only if the “Signature” element is contained in the header of the request. | |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. | 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''' | ||
| Line 61: | Line 46: | ||
|'''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. | ||
|- | |- | ||
| Line 82: | Line 67: | ||
|Might be contained, if several authentication methods are available. (name, type). | |Might be contained, if several authentication methods are available. (name, type). | ||
|} | |} | ||
---- | |||
<div class="prevpage"> | |||
[[4.1.1 "paymentInitiationRequest" interface|<< 4.1.1 "paymentInitiationRequest" interface]] | |||
</div><div class="nextpage"> | |||
[[4.1.3 "updatePaymentResource" interface|4.1.3 "updatePaymentResource" interface >>]] | |||
</div> | |||
Latest revision as of 16:50, 14 March 2019
This API retrieves the status of a 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. |
| 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. |
| 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 payment status request. |
| Error Management | Object identifying the error. |
| transactionStatus | Accepted values:
- ACCP |
| 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). |
