GET /v1/payments

 

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

 payments

Array of Payment

Mandatory 

A list of Payments.

pagination

Pagination

Mandatory

Pagination information about the returned results.

 

Example

 

Request

						
						
curl -X GET \
					
						
						
https://mp-psd2-api.mypos.com/v1/payments \
					
						
						
-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"
					
						
						
 
					
						
						
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',
					
						
						
  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');
					
						
						
$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 
						
						
{
					
						
						
    "payments": [
					
						
						
        {
					
						
						
            "paymentId": "e454aa67-2829-49da-a4e3-9fbcdd6e7545",
					
						
						
            "paymentDateTime": "2019-09-05T14:02:06.803",
					
						
						
            "paymentStatus": "CANC",
					
						
						
            "creditorAccount": "NL14ABNA4415260276",
					
						
						
            "instructedAmount": 20.0,
					
						
						
            "instructedCurrency": "EUR",
					
						
						
            "creditorName": "First Last"
					
						
						
        },
					
						
						
        {
					
						
						
            "paymentId": "f59a74b6-8ba2-4c06-aaf9-e534b48d1bfb",
					
						
						
            "paymentDateTime": "2019-09-05T14:00:24.463",
					
						
						
            "paymentStatus": "CANC",
					
						
						
            "creditorAccount": "NL14ABNA4415260276",
					
						
						
            "instructedAmount": 20.0,
					
						
						
            "instructedCurrency": "EUR",
					
						
						
            "creditorName": "First Last"
					
						
						
        }
					
						
						
    ],
					
						
						
    "pagination": {
					
						
						
        "pageSize": 2,
					
						
						
        "page": 1,
					
						
						
        "total": 2
					
						
						
    }
					
						
						
}