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 performed 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 Code
HTTP Response Code 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'
import requests url = "https://mp-psd2-api.mypos.com/v1/payments/e454aa67-2829-49da-a4e3-9fbcdd6e7545/status" headers = { 'API-Key': "aGDmxHAmpMWUL1txqCsjEcOS", 'X-Request-ID': "a552babc-7081-44e7-9361-61eb17e0bfd9", 'Authorization': "Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X" } response = requests.request("GET", url, headers=headers) print(response.text)
var request = require("request"); var options = { method: 'GET', url: 'https://mp-psd2-api.mypos.com/v1/payments/e454aa67-2829-49da-a4e3-9fbcdd6e7545/status', headers: { 'Authorization': 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X', 'X-Request-ID': 'a552babc-7081-44e7-9361-61eb17e0bfd9', 'API-Key': 'aGDmxHAmpMWUL1txqCsjEcOS' } }; request(options, function (error, response, body) { if (error) throw new Error(error); console.log(body); });
<?php $request = new HttpRequest(); $request->setUrl('https://mp-psd2-api.mypos.com/v1/payments/e454aa67-2829-49da-a4e3-9fbcdd6e7545/status'); $request->setMethod(HTTP_METH_GET); $request->setHeaders(array( 'Authorization' => 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X', 'X-Request-ID' => 'a552babc-7081-44e7-9361-61eb17e0bfd9', 'API-Key' => 'aGDmxHAmpMWUL1txqCsjEcOS' )); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; }
Response
{ "paymentId": "e454aa67-2829-49da-a4e3-9fbcdd6e7545", "paymentStatus": "CANC" }