Get seller tax credits

Credentials

No credentials are documented for this endpoint.

Retrieve tax credits information for a seller including Israeli citizen credits, children credits, education credits, etc.

Parameters

Name In Type Required Description
socialId query string yes Seller Israeli ID number
reportingYear query string yes Reporting year (4 digits)

Code samples

curl

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

Node.js

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

print(response.text)

PHP

<?php

$ch = curl_init('https://sandbox.payme.io/api/partner/api/statistic/seller-credits?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 — Seller credits retrieved successfully (success)

Field Type Description
reportingYear string
seller object
credits object Tax credit sections (Israeli Citizen, Children, Education, Locality, etc.)

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"
}