GET /v1/devices/transactions 

 

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 transactions. Possible values are 1÷100. Default value is 20.

from_date

String

Optional

Starting date of the transaction list in format "YYYY-MM-DD".

to_date

String

Optional

End date of the transaction list, default is “today” if not given. Format is "YYYY-MM-DD".

from_amount

Double

Optional

The minimum amount of a transactions.

to_amount

Double

Optional

The maximum amount of a transactions.

rrn

String

Optional

A filter by RRN value.

stan

String

Optional

Filter by stan value.

terminal_name

String

Optional

Filter by custom POS device name.

reference_number

String

Optional

The reference number of a transaction. Can be filtered by custom client reference.

terminal_id

String

Optional

The unique terminal identifier of the POS device.

terminal_name

String

Optional

The custom name of the POS device.

 

 

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

transactions

List of

Device Transaction

Mandatory

A list of device transaction objects.

reference_number

Inv12345

Optional

Up to 50 symbols of text (Latin characters only) - can include letters, numbers, spaces and special characters.

 

 

Examples

curl --location --request GET 'https://devices-api.mypos.com/v1.1/devices/transactions?page=1&size=5' \
--header 'accept: */*' \
--header 'API-Key: MY_API_KEY' \
--header 'X-Request-ID: 232465ab-66ea-4776-b3f0-f7a123f988e4' \
--header 'Authorization: Bearer 1KGRN5MkgEj27vENGrk9MezHuyqmhAQEoBOSRPFSL8'
import requests

requests.request(
    'GET',
    url='https://devices-api.mypos.com/v1.1/devices/transactions?page=1&size=5',
    data=dict(),
    headers={
        'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
        'Content-Type': 'application/json',
        'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4'
    }
)
const request = require("request");

const options = {
    method: 'GET',
    url: 'https://devices-api.mypos.com/v1.1/devices/transactions',
    body: {},
    json: true,
    headers: {
        'Authorization': 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
        'Content-Type': 'application/json',
        'X-Request-ID': '232465ab-66ea-4776-b3f0-f7a123f988e4'
    }
};

request(options, (error, response, body) => {

});
<?php

$request = new HttpRequest();
$request->setUrl('https://devices-api.mypos.com/v1.1/devices/transactions');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Authorization' => 'Bearer PLpC1CqVE9CYXolbGNBPqz0NYy8asFzG95XcToDsMP',
  'Content-Type' => 'application/json',
  'X-Request-ID' => '232465ab-66ea-4776-b3f0-f7a123f988e4'
));

$request->setBody('{}');

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

{
    "transactions": [
        {
            "terminal_id": "90005826",
            "date": "2019-10-23 11:48:25",
            "terminal_name": "D20050667462",
            "outlet_name": "",
            "tran_type": "00",
            "tran_status": "Approved",
            "payment_status": "Paid",
            "amount": 15.0,
            "currency": "EUR",
            "rrn": "929608098708",
            "stan": "000016",
            "settlement_date": "2019-10-23 11:48:40",
            "settlement_amount": 3.0,
            "settlement_currency": "EUR",
            "fee": 0.02,
            "pan": "*2649",
            "processor": "I",
            "card_scheme": "Visa Classic",
            "payment_reference": "POSA00120076VGMO",
            "reference_number": "9483576"
        },
    ],
    "pagination": {
        "page": 1,
        "size": 20,
        "total": 1
    }
}