Set VAT balance

Credentials

No credentials are documented for this endpoint.

Set VAT balance for a seller

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Field Type Required Description
socialId string no Seller social ID
email string no Seller email
id string no Seller ID
balance number yes Balance amount
reportingYear integer no Reporting year
reportingMonth integer no Reporting month

Request example

No example is documented; this template is generated from the fields — replace the placeholder values.

{
  "socialId": "<socialId>",
  "email": "<email>",
  "id": "<id>",
  "balance": 0,
  "reportingYear": 0,
  "reportingMonth": 0
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/partner/api/sellers/vat-balance' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "balance": 0
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/sellers/vat-balance", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "balance": 0
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/partner/api/sellers/vat-balance",
    json={
        "balance": 0,
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "balance": 0
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/partner/api/sellers/vat-balance');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

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

echo $response;

Responses

200 — VAT balance updated (success)

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