GET /v1.1/online-payments/links
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 transactions. Possible values are 1÷100. Default value is 20. |
status |
Number |
Optional |
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 |
Mandatory |
A list of payment links. |
pagination |
Mandatory |
Information about the paginated results. |
Examples
curl -X GET \ https://transactions-api.mypos.com/v1.1/online-payments/links\ -H 'Authorization: Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP' \ -H 'Content-Type: application/json' \ -H 'API-Key: MY_API_KEY' \ -H 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4'
import requests requests.request( 'GET', url='https://transactions-api.mypos.com/v1.1/online-payments/links', headers={ 'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP', 'Content-Type': 'application/json', 'API-Key': 'MY_API_KEY', 'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4' } )
const request = require("request"); const options = { method: 'GET', url: 'https://transactions-api.mypos.com/v1.1/online-payments/links', headers: { 'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP', 'Content-Type': 'application/json', 'API-Key': 'MY_API_KEY', 'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4' } }; request(options, (error, response, body) => { });
<?php $request = new HttpRequest(); $request->setUrl('https://transactions-api.mypos.com/v1.1/online-payments/links'); $request->setMethod(HTTP_METH_GET); $request->setHeaders(array( 'Authorization' => 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP', 'Content-Type' => 'application/json', 'API-Key' => 'MY_API_KEY', 'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4' )); try { $response = $request->send(); echo $response->getBody(); } catch (HttpException $ex) { echo $ex; }
{ "pagination": { "page_size": 1, "page": 1, "total": 1 }, "items": [ { "code": "B5OEUSYHXZA51", "url": "https://devs.mypos.com/mypos.com/trunk/public/vmp/btn/B5OEUSYHXZA51", "custom_name": "Payment Button", "amount": 6.86, "currency": "EUR", "status": 1 } ] }