Criar submerchant
curl --request POST \
--url https://api.accithus.com/v1/submerchants \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"product_categories": [],
"average_ticket": 1,
"monthly_revenue": 1,
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": true
}
]
}
'import requests
url = "https://api.accithus.com/v1/submerchants"
payload = {
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"product_categories": [],
"average_ticket": 1,
"monthly_revenue": 1,
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": True
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trade_name: '<string>',
legal_name: '<string>',
tax_id: '<string>',
email: '[email protected]',
phone: '<string>',
website: '<string>',
description: '<string>',
soft_descriptor: '<string>',
birth_date: '<string>',
mother_name: '<string>',
product_categories: [],
average_ticket: 1,
monthly_revenue: 1,
mcc: '<string>',
cnaes: [{code: '<string>', description: '<string>', is_primary: true}]
})
};
fetch('https://api.accithus.com/v1/submerchants', 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.accithus.com/v1/submerchants",
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([
'trade_name' => '<string>',
'legal_name' => '<string>',
'tax_id' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'website' => '<string>',
'description' => '<string>',
'soft_descriptor' => '<string>',
'birth_date' => '<string>',
'mother_name' => '<string>',
'product_categories' => [
],
'average_ticket' => 1,
'monthly_revenue' => 1,
'mcc' => '<string>',
'cnaes' => [
[
'code' => '<string>',
'description' => '<string>',
'is_primary' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.accithus.com/v1/submerchants"
payload := strings.NewReader("{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.accithus.com/v1/submerchants")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.accithus.com/v1/submerchants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "pf",
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"status": "pending",
"business_type": "physical",
"product_categories": [
"<string>"
],
"average_ticket": "<string>",
"monthly_revenue": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"review_notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": true
}
]
}
}{
"success": false,
"message": "<string>",
"error": "<string>"
}Submerchants
Criar Submerchant
Cria um submerchant vinculado ao merchant ativo.
POST
/
v1
/
submerchants
Criar submerchant
curl --request POST \
--url https://api.accithus.com/v1/submerchants \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"product_categories": [],
"average_ticket": 1,
"monthly_revenue": 1,
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": true
}
]
}
'import requests
url = "https://api.accithus.com/v1/submerchants"
payload = {
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"product_categories": [],
"average_ticket": 1,
"monthly_revenue": 1,
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": True
}
]
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trade_name: '<string>',
legal_name: '<string>',
tax_id: '<string>',
email: '[email protected]',
phone: '<string>',
website: '<string>',
description: '<string>',
soft_descriptor: '<string>',
birth_date: '<string>',
mother_name: '<string>',
product_categories: [],
average_ticket: 1,
monthly_revenue: 1,
mcc: '<string>',
cnaes: [{code: '<string>', description: '<string>', is_primary: true}]
})
};
fetch('https://api.accithus.com/v1/submerchants', 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.accithus.com/v1/submerchants",
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([
'trade_name' => '<string>',
'legal_name' => '<string>',
'tax_id' => '<string>',
'email' => '[email protected]',
'phone' => '<string>',
'website' => '<string>',
'description' => '<string>',
'soft_descriptor' => '<string>',
'birth_date' => '<string>',
'mother_name' => '<string>',
'product_categories' => [
],
'average_ticket' => 1,
'monthly_revenue' => 1,
'mcc' => '<string>',
'cnaes' => [
[
'code' => '<string>',
'description' => '<string>',
'is_primary' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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.accithus.com/v1/submerchants"
payload := strings.NewReader("{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.accithus.com/v1/submerchants")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.accithus.com/v1/submerchants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trade_name\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"tax_id\": \"<string>\",\n \"email\": \"[email protected]\",\n \"phone\": \"<string>\",\n \"website\": \"<string>\",\n \"description\": \"<string>\",\n \"soft_descriptor\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"mother_name\": \"<string>\",\n \"product_categories\": [],\n \"average_ticket\": 1,\n \"monthly_revenue\": 1,\n \"mcc\": \"<string>\",\n \"cnaes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\",\n \"is_primary\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent_merchant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entity_type": "pf",
"trade_name": "<string>",
"legal_name": "<string>",
"tax_id": "<string>",
"email": "[email protected]",
"phone": "<string>",
"website": "<string>",
"description": "<string>",
"soft_descriptor": "<string>",
"birth_date": "<string>",
"mother_name": "<string>",
"status": "pending",
"business_type": "physical",
"product_categories": [
"<string>"
],
"average_ticket": "<string>",
"monthly_revenue": "<string>",
"reviewed_at": "2023-11-07T05:31:56Z",
"review_notes": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"mcc": "<string>",
"cnaes": [
{
"code": "<string>",
"description": "<string>",
"is_primary": true
}
]
}
}{
"success": false,
"message": "<string>",
"error": "<string>"
}Authorizations
Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.
Body
application/json
Nome fantasia
Required string length:
3 - 255Razão social (PJ) ou nome completo (PF)
Required string length:
3 - 255CPF (11 dígitos para PF) ou CNPJ (14 dígitos para PJ)
Required string length:
11 - 20Tipo de entidade: pf (Pessoa Física / CPF) ou pj (Pessoa Jurídica / CNPJ). Padrão: pj
Available options:
pf, pj Maximum string length:
20Maximum string length:
255Descrição na fatura do cartão
Maximum string length:
22Data de nascimento (YYYY-MM-DD), recomendado para PF
Pattern:
^\d{4}-\d{2}-\d{2}$Nome da mãe, recomendado para PF
Maximum string length:
255Available options:
physical, digital, both Available options:
books, clothes, electronics-and-art, tools-and-utilities, others-physics, infoproducts, software-and-digital-tools, templates-and-graphics-resources, audio-and-soundtracks, plugins-and-extensions, others-digital Ticket médio em centavos
Required range:
x >= 0Receita mensal em centavos
Required range:
x >= 0Código MCC (Merchant Category Code) de 4 dígitos
Required string length:
4Pattern:
^\d{4}$Lista de CNAEs do submerchant
Show child attributes
Show child attributes