Get Payment Status
Retrieve the status of a specific payment created by the Payment Initiation Service (PIS).
Endpoint
GET /v1/payments/{paymentId}/status
Path Parameters
| Attribute | Type | Description |
|---|---|---|
| paymentId | String | Resource identification of the related payment. |
Query Parameters
No query parameters.
Request Headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | ID of the request, unique to the call, as determined by the initiating party (TPP). |
| Authorization | String | Mandatory | The oAuth2 Bearer token obtained from the SCA performed prior to this request. |
| API-Key | String | Mandatory | Consumer key available on the developers portal. |
| Consent-ID | UUID | Mandatory | The consent ID of the related PIS consent. |
Request Body
No request body.
Response
HTTP 200 OK
Response Headers
| Attribute | Type | Condition | Description |
|---|---|---|---|
| X-Request-ID | UUID | Mandatory | ID of the request, unique to the call, as determined by the initiating party (TPP). |
Response Body
| Attribute | Type | Condition | Description |
|---|---|---|---|
| paymentId | String | Mandatory | The unique reference of the payment. |
| paymentStatus | Payment Status | Mandatory | The status of the payment. |
Example
Request
curl -X GET \ https://mp-psd2-api.mypos.com/v1/payments/e454aa67-2829-49da-a4e3-9fbcdd6e7545/status \ -H 'API-Key: aGDmxHAmpMWUL1txqCsjEcOS' \ -H 'Authorization: Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X' \ -H 'X-Request-ID: a552babc-7081-44e7-9361-61eb17e0bfd9' \ -H 'Consent-ID: 3c7816ee-3d51-4bf5-8ced-ece2af35d431'
Response
{
"paymentId": "e454aa67-2829-49da-a4e3-9fbcdd6e7545",
"paymentStatus": "CANC"
}