Activate social security

• Sandbox: POST https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security
• Production: POST https://live.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security

Credentials

No credentials are documented for this endpoint.

Activate social security (ביטוח לאומי) reporting for a seller. This enables automatic social security payment tracking and reporting.

Parameters

This endpoint takes no path, query or header parameters.

Request body

Content type: application/json

Field	Type	Required	Description
id	string	yes	Seller ID
email	string	no	Seller email (alternative identifier)
socialId	string	no	Seller social/business ID (alternative identifier)
socialSecurityNumber	string	no	Social security (Bituach Leumi) number
activationDate	string	no	Date from which social security reporting is active
paymentFrequency	string	no	Payment frequency for social security contributions

Request example

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "socialSecurityNumber": "123456789",
  "activationDate": "2024-01-01",
  "paymentFrequency": "monthly"
}

Code samples

curl

curl -X POST 'https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "socialSecurityNumber": "123456789",
  "activationDate": "2024-01-01",
  "paymentFrequency": "monthly"
}'

Node.js

const response = await fetch("https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "socialSecurityNumber": "123456789",
    "activationDate": "2024-01-01",
    "paymentFrequency": "monthly"
  }),
});

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

Python

import requests

response = requests.post(
    "https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security",
    json={
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "socialSecurityNumber": "123456789",
        "activationDate": "2024-01-01",
        "paymentFrequency": "monthly",
    },
)

print(response.text)

PHP

<?php

$body = <<<'BODY'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "socialSecurityNumber": "123456789",
  "activationDate": "2024-01-01",
  "paymentFrequency": "monthly"
}
BODY;

$ch = curl_init('https://sandbox.payme.io/api/partner/api/tax-authority/tax-and-social-activation/social-security');
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 — Social security activated successfully (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"
}