GET /v1.1/online-payments/payment-requests/

Request headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call.
Authorization	String	Mandatory	The oAuth2 Bearer token
API-Key	String	Mandatory	The Client ID obtained from the myPOS Account

Query parameters

Attribute	Type	Condition	Description
page	Number	Optional	The page with transactions to be returned. Default is 1.
size	Number	Optional	The number of returned requests. Possible values are 1÷100. Default value is 8.
status	Number	Optional	Available values.
code	String	Optional	The code of a sent payment request.
from_amount	Decimal	Optional	The minimum amount of a payment request for which to return as a valid entry.
to_amount	Decimal	Optional	The maximum amount of a payment request for which to return as a valid entry.
currency	String	Optional	The currency in which requests were sent. The default value is EUR.
from_date	String	Optional	The starting date from which a payment request was sent to return valid entries.
to_date	String	Optional	The last date from which a payment request was sent to return valid entries.
client_name	String	Optional	The name of the client to whom a payment request was sent.
reason	String	Optional	The reason typed in a sent payment request.
booking_text	String	Optional	The booking text typed in a sent payment request.

Response headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call.
Content-Type	String	Mandatory	application/json

Response body

Attribute	Type	Condition	Description
items	List of Payment Requests	Mandatory	A list of payment requests.
pagination	Pagination	Mandatory	Information about the paginated results.

Examples

						 						curl --location --request GET 'https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=' \ 					
						 						--header 'API-Key: MY_API_KEY' \ 					
						 						--header 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4' \ 					
						 						--header 'Authorization: Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs' \ 					
						 						--data-raw ''

						 						import requests 					
						 						 					
						 						url = "https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=" 					
						 						 					
						 						payload={} 					
						 						headers = { 					
						 						  'API-Key': 'MY_API_KEY', 					
						 						  'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4', 					
						 						  'Authorization': 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs' 					
						 						} 					
						 						 					
						 						response = requests.request("GET", url, headers=headers, data=payload)

						 						var request = require('request'); 					
						 						var options = { 					
						 						  'method': 'GET', 					
						 						  'url': 'https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=', 					
						 						  'headers': { 					
						 						    'API-Key': 'MY_API_KEY', 					
						 						    'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4', 					
						 						    'Authorization': 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs' 					
						 						  } 					
						 						}; 					
						 						request(options, function (error, response) { 					
						 						 					
						 						});

						 						<?php 					
						 						require_once 'HTTP/Request2.php'; 					
						 						$request = new HTTP_Request2(); 					
						 						$request->setUrl('https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text='); 					
						 						$request->setMethod(HTTP_Request2::METHOD_GET); 					
						 						$request->setConfig(array( 					
						 						  'follow_redirects' => TRUE 					
						 						)); 					
						 						$request->setHeader(array( 					
						 						  'API-Key' => 'MY_API_KEY', 					
						 						  'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4', 					
						 						  'Authorization' => 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs' 					
						 						)); 					
						 						$request->setBody(''); 					
						 						try { 					
						 						  $response = $request->send(); 					
						 						  if ($response->getStatus() == 200) { 					
						 						    echo $response->getBody(); 					
						 						  } 					
						 						  else { 					
						 						    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' . 					
						 						    $response->getReasonPhrase(); 					
						 						  } 					
						 						} 					
						 						catch(HTTP_Request2_Exception $e) { 					
						 						  echo 'Error: ' . $e->getMessage(); 					
						 						}

						 						{ 					
						 						    "pagination": { 					
						 						        "page_size": 10, 					
						 						        "page": 1, 					
						 						        "total": 10 					
						 						    }, 					
						 						    "items": [ 					
						 						        { 					
						 						            "code": "BDQKP6JD5VDX77", 					
						 						            "url": "https://mypos.eu/en/qr-pr/BDQKP6JD5VDX77", 					
						 						            "added_on": "2021-03-17 16:00:36", 					
						 						            "client_name": "", 					
						 						            "amount": 3.14, 					
						 						            "currency": "EUR", 					
						 						            "reason": "", 					
						 						            "booking_text": "", 					
						 						            "status": 1 					
						 						        }, 					
						 										... 					
						 						    ] 					
						 						}

	curl --location --request GET 'https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=' \
	--header 'API-Key: MY_API_KEY' \
	--header 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4' \
	--header 'Authorization: Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs' \
	--data-raw ''

	import requests

	url = "https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text="

	payload={}
	headers = {
	'API-Key': 'MY_API_KEY',
	'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
	'Authorization': 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs'
	}

	response = requests.request("GET", url, headers=headers, data=payload)

	var request = require('request');
	var options = {
	'method': 'GET',
	'url': 'https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=',
	'headers': {
	'API-Key': 'MY_API_KEY',
	'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4',
	'Authorization': 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs'
	}
	};
	request(options, function (error, response) {

	});

	<?php
	require_once 'HTTP/Request2.php';
	$request = new HTTP_Request2();
	$request->setUrl('https://transactions-api.mypos.com/v1.1/online-payments/payment-requests?page=1&size=10&status=1&code=&from_amount=2&to_amount=100&currency=EUR&from_date=2021-03-01&to_date=2021-04-01&client_name=&reason=&booking_text=');
	$request->setMethod(HTTP_Request2::METHOD_GET);
	$request->setConfig(array(
	'follow_redirects' => TRUE
	));
	$request->setHeader(array(
	'API-Key' => 'MY_API_KEY',
	'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4',
	'Authorization' => 'Bearer fTOPLnikHBzQb1u7eHvptz5fAe9V8ltn7k238sPRMs'
	));
	$request->setBody('');
	try {
	$response = $request->send();
	if ($response->getStatus() == 200) {
	echo $response->getBody();
	}
	else {
	echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
	$response->getReasonPhrase();
	}
	}
	catch(HTTP_Request2_Exception $e) {
	echo 'Error: ' . $e->getMessage();
	}

	{
	"pagination": {
	"page_size": 10,
	"page": 1,
	"total": 10
	},
	"items": [
	{
	"code": "BDQKP6JD5VDX77",
	"url": "https://mypos.eu/en/qr-pr/BDQKP6JD5VDX77",
	"added_on": "2021-03-17 16:00:36",
	"client_name": "",
	"amount": 3.14,
	"currency": "EUR",
	"reason": "",
	"booking_text": "",
	"status": 1
	},
	...
	]
	}