Criar Assinaturas em Massa
curl --request POST \
--url https://api.example.com/subscriptions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"start_date": "<string>",
"expiry_date": "<string>",
"plan_id": "<string>",
"is_group_plan": true,
"group_size": "<string>",
"benefit_holder": "<string>",
"beneficiary": {
"beneficiary.primary_card": "<string>",
"beneficiary.user_card": "<string>",
"beneficiary.name": "<string>",
"beneficiary.cpf": "<string>",
"beneficiary.birth_date": "<string>",
"beneficiary.gender": "<string>",
"beneficiary.email": "<string>",
"beneficiary.phone_number": "<string>",
"beneficiary.address": {
"beneficiary.address.zipcode": "<string>",
"beneficiary.address.street": "<string>",
"beneficiary.address.number": "<string>",
"beneficiary.address.complement": "<string>",
"beneficiary.address.neighborhood": "<string>",
"beneficiary.address.city": "<string>",
"beneficiary.address.state": "<string>"
}
},
"partner_metadata": "<string>",
"partner_internal_id": "<string>"
}
'import requests
url = "https://api.example.com/subscriptions"
payload = {
"start_date": "<string>",
"expiry_date": "<string>",
"plan_id": "<string>",
"is_group_plan": True,
"group_size": "<string>",
"benefit_holder": "<string>",
"beneficiary": {
"beneficiary.primary_card": "<string>",
"beneficiary.user_card": "<string>",
"beneficiary.name": "<string>",
"beneficiary.cpf": "<string>",
"beneficiary.birth_date": "<string>",
"beneficiary.gender": "<string>",
"beneficiary.email": "<string>",
"beneficiary.phone_number": "<string>",
"beneficiary.address": {
"beneficiary.address.zipcode": "<string>",
"beneficiary.address.street": "<string>",
"beneficiary.address.number": "<string>",
"beneficiary.address.complement": "<string>",
"beneficiary.address.neighborhood": "<string>",
"beneficiary.address.city": "<string>",
"beneficiary.address.state": "<string>"
}
},
"partner_metadata": "<string>",
"partner_internal_id": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_date: '<string>',
expiry_date: '<string>',
plan_id: '<string>',
is_group_plan: true,
group_size: '<string>',
benefit_holder: '<string>',
beneficiary: {
'beneficiary.primary_card': '<string>',
'beneficiary.user_card': '<string>',
'beneficiary.name': '<string>',
'beneficiary.cpf': '<string>',
'beneficiary.birth_date': '<string>',
'beneficiary.gender': '<string>',
'beneficiary.email': '<string>',
'beneficiary.phone_number': '<string>',
'beneficiary.address': {
'beneficiary.address.zipcode': '<string>',
'beneficiary.address.street': '<string>',
'beneficiary.address.number': '<string>',
'beneficiary.address.complement': '<string>',
'beneficiary.address.neighborhood': '<string>',
'beneficiary.address.city': '<string>',
'beneficiary.address.state': '<string>'
}
},
partner_metadata: '<string>',
partner_internal_id: '<string>'
})
};
fetch('https://api.example.com/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_date' => '<string>',
'expiry_date' => '<string>',
'plan_id' => '<string>',
'is_group_plan' => true,
'group_size' => '<string>',
'benefit_holder' => '<string>',
'beneficiary' => [
'beneficiary.primary_card' => '<string>',
'beneficiary.user_card' => '<string>',
'beneficiary.name' => '<string>',
'beneficiary.cpf' => '<string>',
'beneficiary.birth_date' => '<string>',
'beneficiary.gender' => '<string>',
'beneficiary.email' => '<string>',
'beneficiary.phone_number' => '<string>',
'beneficiary.address' => [
'beneficiary.address.zipcode' => '<string>',
'beneficiary.address.street' => '<string>',
'beneficiary.address.number' => '<string>',
'beneficiary.address.complement' => '<string>',
'beneficiary.address.neighborhood' => '<string>',
'beneficiary.address.city' => '<string>',
'beneficiary.address.state' => '<string>'
]
],
'partner_metadata' => '<string>',
'partner_internal_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/subscriptions"
payload := strings.NewReader("{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/subscriptions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": "success",
"total_created_items": 1,
"total_not_created_items": 0,
"not_created_items": []
}
{
"message": "Não autorizado"
}
{
"message": "Erro de Aplicação"
}
Assinaturas
Criar Assinaturas em Massa
Cria múltiplas assinaturas de uma só vez para beneficiários.
POST
/
subscriptions
Criar Assinaturas em Massa
curl --request POST \
--url https://api.example.com/subscriptions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"start_date": "<string>",
"expiry_date": "<string>",
"plan_id": "<string>",
"is_group_plan": true,
"group_size": "<string>",
"benefit_holder": "<string>",
"beneficiary": {
"beneficiary.primary_card": "<string>",
"beneficiary.user_card": "<string>",
"beneficiary.name": "<string>",
"beneficiary.cpf": "<string>",
"beneficiary.birth_date": "<string>",
"beneficiary.gender": "<string>",
"beneficiary.email": "<string>",
"beneficiary.phone_number": "<string>",
"beneficiary.address": {
"beneficiary.address.zipcode": "<string>",
"beneficiary.address.street": "<string>",
"beneficiary.address.number": "<string>",
"beneficiary.address.complement": "<string>",
"beneficiary.address.neighborhood": "<string>",
"beneficiary.address.city": "<string>",
"beneficiary.address.state": "<string>"
}
},
"partner_metadata": "<string>",
"partner_internal_id": "<string>"
}
'import requests
url = "https://api.example.com/subscriptions"
payload = {
"start_date": "<string>",
"expiry_date": "<string>",
"plan_id": "<string>",
"is_group_plan": True,
"group_size": "<string>",
"benefit_holder": "<string>",
"beneficiary": {
"beneficiary.primary_card": "<string>",
"beneficiary.user_card": "<string>",
"beneficiary.name": "<string>",
"beneficiary.cpf": "<string>",
"beneficiary.birth_date": "<string>",
"beneficiary.gender": "<string>",
"beneficiary.email": "<string>",
"beneficiary.phone_number": "<string>",
"beneficiary.address": {
"beneficiary.address.zipcode": "<string>",
"beneficiary.address.street": "<string>",
"beneficiary.address.number": "<string>",
"beneficiary.address.complement": "<string>",
"beneficiary.address.neighborhood": "<string>",
"beneficiary.address.city": "<string>",
"beneficiary.address.state": "<string>"
}
},
"partner_metadata": "<string>",
"partner_internal_id": "<string>"
}
headers = {
"x-api-key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
start_date: '<string>',
expiry_date: '<string>',
plan_id: '<string>',
is_group_plan: true,
group_size: '<string>',
benefit_holder: '<string>',
beneficiary: {
'beneficiary.primary_card': '<string>',
'beneficiary.user_card': '<string>',
'beneficiary.name': '<string>',
'beneficiary.cpf': '<string>',
'beneficiary.birth_date': '<string>',
'beneficiary.gender': '<string>',
'beneficiary.email': '<string>',
'beneficiary.phone_number': '<string>',
'beneficiary.address': {
'beneficiary.address.zipcode': '<string>',
'beneficiary.address.street': '<string>',
'beneficiary.address.number': '<string>',
'beneficiary.address.complement': '<string>',
'beneficiary.address.neighborhood': '<string>',
'beneficiary.address.city': '<string>',
'beneficiary.address.state': '<string>'
}
},
partner_metadata: '<string>',
partner_internal_id: '<string>'
})
};
fetch('https://api.example.com/subscriptions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/subscriptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'start_date' => '<string>',
'expiry_date' => '<string>',
'plan_id' => '<string>',
'is_group_plan' => true,
'group_size' => '<string>',
'benefit_holder' => '<string>',
'beneficiary' => [
'beneficiary.primary_card' => '<string>',
'beneficiary.user_card' => '<string>',
'beneficiary.name' => '<string>',
'beneficiary.cpf' => '<string>',
'beneficiary.birth_date' => '<string>',
'beneficiary.gender' => '<string>',
'beneficiary.email' => '<string>',
'beneficiary.phone_number' => '<string>',
'beneficiary.address' => [
'beneficiary.address.zipcode' => '<string>',
'beneficiary.address.street' => '<string>',
'beneficiary.address.number' => '<string>',
'beneficiary.address.complement' => '<string>',
'beneficiary.address.neighborhood' => '<string>',
'beneficiary.address.city' => '<string>',
'beneficiary.address.state' => '<string>'
]
],
'partner_metadata' => '<string>',
'partner_internal_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <x-api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/subscriptions"
payload := strings.NewReader("{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<x-api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/subscriptions")
.header("x-api-key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/subscriptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"start_date\": \"<string>\",\n \"expiry_date\": \"<string>\",\n \"plan_id\": \"<string>\",\n \"is_group_plan\": true,\n \"group_size\": \"<string>\",\n \"benefit_holder\": \"<string>\",\n \"beneficiary\": {\n \"beneficiary.primary_card\": \"<string>\",\n \"beneficiary.user_card\": \"<string>\",\n \"beneficiary.name\": \"<string>\",\n \"beneficiary.cpf\": \"<string>\",\n \"beneficiary.birth_date\": \"<string>\",\n \"beneficiary.gender\": \"<string>\",\n \"beneficiary.email\": \"<string>\",\n \"beneficiary.phone_number\": \"<string>\",\n \"beneficiary.address\": {\n \"beneficiary.address.zipcode\": \"<string>\",\n \"beneficiary.address.street\": \"<string>\",\n \"beneficiary.address.number\": \"<string>\",\n \"beneficiary.address.complement\": \"<string>\",\n \"beneficiary.address.neighborhood\": \"<string>\",\n \"beneficiary.address.city\": \"<string>\",\n \"beneficiary.address.state\": \"<string>\"\n }\n },\n \"partner_metadata\": \"<string>\",\n \"partner_internal_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"result": "success",
"total_created_items": 1,
"total_not_created_items": 0,
"not_created_items": []
}
{
"message": "Não autorizado"
}
{
"message": "Erro de Aplicação"
}
Visão Geral
Este endpoint permite que parceiros criem assinaturas em massa para múltiplos beneficiários em uma única requisição. É ideal para onboarding de grupos de usuários ou empresas.Autenticação
string
required
Sua chave de API fornecida pela Zentek. Exemplo:
ztk_live_...Request Body
O corpo da requisição deve ser um array de objetos, onde cada objeto representa uma assinatura.string
required
Data de início da assinatura no formato ISO 8601. Exemplo:
2024-01-01string
required
Data de expiração da assinatura no formato ISO 8601. Deixe vazio para assinatura sem data de término.
string
required
Identificador único do plano. Exemplo:
plan_10000boolean
required
Define se é uma assinatura em grupo (true/false).
string
Tamanho do grupo. Mínimo: 50. Obrigatório se
is_group_plan for true.string
CNPJ do titular do benefício (empresa). Obrigatório se
is_group_plan for true.object
required
Objeto contendo os dados do beneficiário.
Show Campos do Beneficiário
Show Campos do Beneficiário
string
required
Número do cartão principal. Exemplo:
27030474015string
required
Número do cartão do usuário.
string
required
Nome completo do beneficiário.
string
required
CPF do beneficiário (apenas números).
string
required
Data de nascimento no formato ISO 8601. Exemplo:
1990-02-22string
required
Gênero:
M (masculino) ou F (feminino).string
required
E-mail do beneficiário.
string
required
Telefone com código do país. Exemplo:
+5511996042491string
String JSON contendo metadados adicionais do parceiro (opcional).
string
ID interno do parceiro para referência (opcional).
Exemplo de Request
curl -X POST "https://api.partner.zentek.com.br/v1/subscriptions" \
-H "Content-Type: application/json" \
-H "x-api-key: SUA_API_KEY" \
-d '[
{
"start_date": "2024-01-01",
"expiry_date": "2025-01-01",
"plan_id": "plan_10000",
"is_group_plan": false,
"group_size": "",
"benefit_holder": "",
"beneficiary": {
"primary_card": "27030474015",
"user_card": "27030474015",
"name": "João Silva",
"cpf": "34567898233",
"birth_date": "1990-02-22",
"gender": "M",
"email": "joao.silva@example.com",
"address": {
"zipcode": "06454040",
"street": "Rua Exemplo",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP"
},
"phone_number": "+5511996042491"
},
"partner_metadata": "{\"customer_id\": \"12345\"}"
}
]'
const response = await fetch('https://api.partner.zentek.com.br/v1/subscriptions', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'SUA_API_KEY'
},
body: JSON.stringify([
{
start_date: '2024-01-01',
expiry_date: '2025-01-01',
plan_id: 'plan_10000',
is_group_plan: false,
beneficiary: {
primary_card: '27030474015',
user_card: '27030474015',
name: 'João Silva',
cpf: '34567898233',
birth_date: '1990-02-22',
gender: 'M',
email: 'joao.silva@example.com',
address: {
zipcode: '06454040',
street: 'Rua Exemplo',
number: '123',
neighborhood: 'Centro',
city: 'São Paulo',
state: 'SP'
},
phone_number: '+5511996042491'
}
}
])
});
Response
string
Resultado geral da operação.
number
Número total de assinaturas criadas com sucesso.
number
Número total de assinaturas que falharam.
array
{
"result": "success",
"total_created_items": 1,
"total_not_created_items": 0,
"not_created_items": []
}
{
"message": "Não autorizado"
}
{
"message": "Erro de Aplicação"
}
Was this page helpful?
⌘I