Get financial checkpoints

• Sandbox: GET https://sandbox.payme.io/api/partner/api/statistic/checkpoints
• Production: GET https://live.payme.io/api/partner/api/statistic/checkpoints

Credentials

No credentials are documented for this endpoint.

Retrieve financial checkpoints for a seller

Parameters

Name	In	Type	Required	Description
socialId	query	string	yes	Seller social/business ID
reportingYear	query	integer	yes	Reporting year
reportingMonths	query	string	no	Reporting months array

Code samples

curl

curl -X GET 'https://sandbox.payme.io/api/partner/api/statistic/checkpoints?socialId=<socialId>&reportingYear=<reportingYear>'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/statistic/checkpoints?socialId=<socialId>&reportingYear=<reportingYear>", {
  method: "GET",
});

console.log(await response.text());

Python

import requests

response = requests.get(
    "https://sandbox.payme.io/api/partner/api/statistic/checkpoints?socialId=<socialId>&reportingYear=<reportingYear>",
)

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/partner/api/statistic/checkpoints?socialId=<socialId>&reportingYear=<reportingYear>');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Responses

200 — Successful response (success)

Field	Type	Description
checkpoints	array

400 — Bad Request (error)

Field	Type	Description
statusCode	integer	HTTP status code
message	string	Error message(s)
error	string	Error type

{
  "statusCode": 400,
  "message": [
    "Validation failed"
  ],
  "error": "Bad Request"
}

401 — Unauthorized (error)

Field	Type	Description
error	string
error_description	string

{
  "error": "unauthorized_client",
  "error_description": "Client authentication failed"
}