Activate tax and social security

Credentials

No credentials are documented for this endpoint.

Activate tax authority and social security integration with rates and validity dates.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Field Type Required Description
seller_email string yes
seller_id_number string yes
social_security_adv_rate number yes Social security advance rate
tax_origin_rate number yes Tax origin rate (0-1)
tax_origin_rate_validity_date string yes
boooks_good_standing_validity_date string yes
files_path string yes

Request example

{
  "seller_email": "seller@example.com",
  "seller_id_number": "123456789",
  "social_security_adv_rate": 350,
  "tax_origin_rate": 0.1,
  "tax_origin_rate_validity_date": "2024-12-31",
  "boooks_good_standing_validity_date": "2024-12-31",
  "files_path": "uploads/tax-auth"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "seller_email": "seller@example.com",
  "seller_id_number": "123456789",
  "social_security_adv_rate": 350,
  "tax_origin_rate": 0.1,
  "tax_origin_rate_validity_date": "2024-12-31",
  "boooks_good_standing_validity_date": "2024-12-31",
  "files_path": "uploads/tax-auth"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seller_email": "seller@example.com",
    "seller_id_number": "123456789",
    "social_security_adv_rate": 350,
    "tax_origin_rate": 0.1,
    "tax_origin_rate_validity_date": "2024-12-31",
    "boooks_good_standing_validity_date": "2024-12-31",
    "files_path": "uploads/tax-auth"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation",
    json={
        "seller_email": "seller@example.com",
        "seller_id_number": "123456789",
        "social_security_adv_rate": 350,
        "tax_origin_rate": 0.1,
        "tax_origin_rate_validity_date": "2024-12-31",
        "boooks_good_standing_validity_date": "2024-12-31",
        "files_path": "uploads/tax-auth",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "seller_email": "seller@example.com",
  "seller_id_number": "123456789",
  "social_security_adv_rate": 350,
  "tax_origin_rate": 0.1,
  "tax_origin_rate_validity_date": "2024-12-31",
  "boooks_good_standing_validity_date": "2024-12-31",
  "files_path": "uploads/tax-auth"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation');
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 — Tax and social activation successful (success)

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