Get financial checkpoints (Internal API)

This is a variant of GET /partner/api/statistic/checkpoints — Get financial checkpoints; the request and responses below are the ones documented for Internal API.

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 comprehensive financial checkpoints for a seller including income, expenses, tax data, paychecks, and direct debit status.

Parameters

Name	In	Type	Required	Description
`socialId`	query	string	yes	Seller Israeli ID number
`reportingYear`	query	string	yes	Reporting year (4 digits)
`reportingMonths`	query	string	yes	Array of reporting months (1-12)

Code samples

curl

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

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/statistic/checkpoints?socialId=<socialId>&reportingYear=<reportingYear>&reportingMonths=<reportingMonths>", {
  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>&reportingMonths=<reportingMonths>",
)

print(response.text)

PHP

<?php

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

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

echo $response;

Responses

200 — Checkpoints retrieved successfully (success)

Field	Type	Description
`reportingYear`	string
`reportingMonths`	array
`seller`	object
`seller.firstName`	string
`seller.lastName`	string
`seller.sellerStatus`	string
`seller.accountEmail`	string
`seller.phone`	string
`seller.businessNumber`	integer
`seller.businessType`	string
`seller.industryClassificationId`	integer
`seller.idNumber`	integer
`seller.socialSecurityAdvAmount`	number
`directDebit`	object	Direct debit authorization statuses
`paychecks`	object
`paychecks.totalIncome`	number
`paychecks.totalTax`	number
`paychecks.creditPoints`	number
`paychecks.marginalTaxRate`	number

400 — Bad Request - Validation failed (error)

Field	Type	Description
`statusCode`	integer
`message`	string
`error`	string

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

401 — Unauthorized - Invalid or missing authentication (error)

Field	Type	Description
`statusCode`	integer
`message`	string
`error`	string

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Unauthorized"
}