Add or update gateway credentials
curl --request PUT \
--url http://localhost:7701/api/v1/company/gateways \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"gateways": [
{
"gateway_slug": "pagarme",
"secret_key": "sk_live_abc123",
"order": 1,
"client_id": "client_xyz",
"use_as_subaccount": false,
"subaccount_information": {
"name": "Maria Silva",
"trading_name": "Loja da Maria",
"email": "maria@example.com",
"document": "123.456.789-00",
"type": "individual",
"annual_revenue": 120000,
"company_type": "LTDA",
"birthdate": "1990-06-15",
"monthly_income": 500000,
"professional_occupation": "Software Engineer",
"phone_numbers": [
{
"country": "BR",
"number": "999999999",
"type": "mobile"
}
],
"address": {
"street": "Rua das Flores",
"complementary": "Apto 101",
"number": "123",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310-100"
},
"default_bank_account": {
"holder_name": "Maria Silva",
"holder_type": "individual",
"holder_document": "123.456.789-00",
"bank_code": "341",
"branch_number": "0001",
"account_number": "12345678",
"account_check_digit": "9",
"type": "checking"
},
"managing_partners": [
{
"name": "João Souza",
"email": "joao@example.com",
"document": "987.654.321-00",
"birthdate": "1985-03-20",
"monthly_income": 300000,
"professional_occupation": "Director",
"self_declared_legal_representative": true,
"address": {
"street": "Av. Paulista",
"complementary": "Sala 5",
"street_number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01311100",
"reference_point": "Próximo ao metrô"
},
"phone_numbers": [
{
"ddd": "11",
"number": "999999999"
}
]
}
]
}
}
]
}
'import requests
url = "http://localhost:7701/api/v1/company/gateways"
payload = { "gateways": [
{
"gateway_slug": "pagarme",
"secret_key": "sk_live_abc123",
"order": 1,
"client_id": "client_xyz",
"use_as_subaccount": False,
"subaccount_information": {
"name": "Maria Silva",
"trading_name": "Loja da Maria",
"email": "maria@example.com",
"document": "123.456.789-00",
"type": "individual",
"annual_revenue": 120000,
"company_type": "LTDA",
"birthdate": "1990-06-15",
"monthly_income": 500000,
"professional_occupation": "Software Engineer",
"phone_numbers": [
{
"country": "BR",
"number": "999999999",
"type": "mobile"
}
],
"address": {
"street": "Rua das Flores",
"complementary": "Apto 101",
"number": "123",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310-100"
},
"default_bank_account": {
"holder_name": "Maria Silva",
"holder_type": "individual",
"holder_document": "123.456.789-00",
"bank_code": "341",
"branch_number": "0001",
"account_number": "12345678",
"account_check_digit": "9",
"type": "checking"
},
"managing_partners": [
{
"name": "João Souza",
"email": "joao@example.com",
"document": "987.654.321-00",
"birthdate": "1985-03-20",
"monthly_income": 300000,
"professional_occupation": "Director",
"self_declared_legal_representative": True,
"address": {
"street": "Av. Paulista",
"complementary": "Sala 5",
"street_number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01311100",
"reference_point": "Próximo ao metrô"
},
"phone_numbers": [
{
"ddd": "11",
"number": "999999999"
}
]
}
]
}
}
] }
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
gateways: [
{
gateway_slug: 'pagarme',
secret_key: 'sk_live_abc123',
order: 1,
client_id: 'client_xyz',
use_as_subaccount: false,
subaccount_information: {
name: 'Maria Silva',
trading_name: 'Loja da Maria',
email: 'maria@example.com',
document: '123.456.789-00',
type: 'individual',
annual_revenue: 120000,
company_type: 'LTDA',
birthdate: '1990-06-15',
monthly_income: 500000,
professional_occupation: 'Software Engineer',
phone_numbers: [{country: 'BR', number: '999999999', type: 'mobile'}],
address: {
street: 'Rua das Flores',
complementary: 'Apto 101',
number: '123',
neighborhood: 'Centro',
city: 'São Paulo',
state: 'SP',
zip_code: '01310-100'
},
default_bank_account: {
holder_name: 'Maria Silva',
holder_type: 'individual',
holder_document: '123.456.789-00',
bank_code: '341',
branch_number: '0001',
account_number: '12345678',
account_check_digit: '9',
type: 'checking'
},
managing_partners: [
{
name: 'João Souza',
email: 'joao@example.com',
document: '987.654.321-00',
birthdate: '1985-03-20',
monthly_income: 300000,
professional_occupation: 'Director',
self_declared_legal_representative: true,
address: {
street: 'Av. Paulista',
complementary: 'Sala 5',
street_number: '1000',
neighborhood: 'Bela Vista',
city: 'São Paulo',
state: 'SP',
zip_code: '01311100',
reference_point: 'Próximo ao metrô'
},
phone_numbers: [{ddd: '11', number: '999999999'}]
}
]
}
}
]
})
};
fetch('http://localhost:7701/api/v1/company/gateways', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/company/gateways",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'gateways' => [
[
'gateway_slug' => 'pagarme',
'secret_key' => 'sk_live_abc123',
'order' => 1,
'client_id' => 'client_xyz',
'use_as_subaccount' => false,
'subaccount_information' => [
'name' => 'Maria Silva',
'trading_name' => 'Loja da Maria',
'email' => 'maria@example.com',
'document' => '123.456.789-00',
'type' => 'individual',
'annual_revenue' => 120000,
'company_type' => 'LTDA',
'birthdate' => '1990-06-15',
'monthly_income' => 500000,
'professional_occupation' => 'Software Engineer',
'phone_numbers' => [
[
'country' => 'BR',
'number' => '999999999',
'type' => 'mobile'
]
],
'address' => [
'street' => 'Rua das Flores',
'complementary' => 'Apto 101',
'number' => '123',
'neighborhood' => 'Centro',
'city' => 'São Paulo',
'state' => 'SP',
'zip_code' => '01310-100'
],
'default_bank_account' => [
'holder_name' => 'Maria Silva',
'holder_type' => 'individual',
'holder_document' => '123.456.789-00',
'bank_code' => '341',
'branch_number' => '0001',
'account_number' => '12345678',
'account_check_digit' => '9',
'type' => 'checking'
],
'managing_partners' => [
[
'name' => 'João Souza',
'email' => 'joao@example.com',
'document' => '987.654.321-00',
'birthdate' => '1985-03-20',
'monthly_income' => 300000,
'professional_occupation' => 'Director',
'self_declared_legal_representative' => true,
'address' => [
'street' => 'Av. Paulista',
'complementary' => 'Sala 5',
'street_number' => '1000',
'neighborhood' => 'Bela Vista',
'city' => 'São Paulo',
'state' => 'SP',
'zip_code' => '01311100',
'reference_point' => 'Próximo ao metrô'
],
'phone_numbers' => [
[
'ddd' => '11',
'number' => '999999999'
]
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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 := "http://localhost:7701/api/v1/company/gateways"
payload := strings.NewReader("{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-API-Key", "<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.put("http://localhost:7701/api/v1/company/gateways")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/company/gateways")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"company_id": 42,
"gateway_id": 1,
"gateway_slug": "pagarme",
"client_id": null,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
}Company Gateways
Add or update gateway credentials
Creates or updates credentials for one or more gateways scoped to the authenticated company. When use_as_subaccount is true the gateway creates a recipient sub-account and stores the resulting recipient ID as the secret key.
PUT
/
api
/
v1
/
company
/
gateways
Add or update gateway credentials
curl --request PUT \
--url http://localhost:7701/api/v1/company/gateways \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--header 'x-client-id: <x-client-id>' \
--data '
{
"gateways": [
{
"gateway_slug": "pagarme",
"secret_key": "sk_live_abc123",
"order": 1,
"client_id": "client_xyz",
"use_as_subaccount": false,
"subaccount_information": {
"name": "Maria Silva",
"trading_name": "Loja da Maria",
"email": "maria@example.com",
"document": "123.456.789-00",
"type": "individual",
"annual_revenue": 120000,
"company_type": "LTDA",
"birthdate": "1990-06-15",
"monthly_income": 500000,
"professional_occupation": "Software Engineer",
"phone_numbers": [
{
"country": "BR",
"number": "999999999",
"type": "mobile"
}
],
"address": {
"street": "Rua das Flores",
"complementary": "Apto 101",
"number": "123",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310-100"
},
"default_bank_account": {
"holder_name": "Maria Silva",
"holder_type": "individual",
"holder_document": "123.456.789-00",
"bank_code": "341",
"branch_number": "0001",
"account_number": "12345678",
"account_check_digit": "9",
"type": "checking"
},
"managing_partners": [
{
"name": "João Souza",
"email": "joao@example.com",
"document": "987.654.321-00",
"birthdate": "1985-03-20",
"monthly_income": 300000,
"professional_occupation": "Director",
"self_declared_legal_representative": true,
"address": {
"street": "Av. Paulista",
"complementary": "Sala 5",
"street_number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01311100",
"reference_point": "Próximo ao metrô"
},
"phone_numbers": [
{
"ddd": "11",
"number": "999999999"
}
]
}
]
}
}
]
}
'import requests
url = "http://localhost:7701/api/v1/company/gateways"
payload = { "gateways": [
{
"gateway_slug": "pagarme",
"secret_key": "sk_live_abc123",
"order": 1,
"client_id": "client_xyz",
"use_as_subaccount": False,
"subaccount_information": {
"name": "Maria Silva",
"trading_name": "Loja da Maria",
"email": "maria@example.com",
"document": "123.456.789-00",
"type": "individual",
"annual_revenue": 120000,
"company_type": "LTDA",
"birthdate": "1990-06-15",
"monthly_income": 500000,
"professional_occupation": "Software Engineer",
"phone_numbers": [
{
"country": "BR",
"number": "999999999",
"type": "mobile"
}
],
"address": {
"street": "Rua das Flores",
"complementary": "Apto 101",
"number": "123",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"zip_code": "01310-100"
},
"default_bank_account": {
"holder_name": "Maria Silva",
"holder_type": "individual",
"holder_document": "123.456.789-00",
"bank_code": "341",
"branch_number": "0001",
"account_number": "12345678",
"account_check_digit": "9",
"type": "checking"
},
"managing_partners": [
{
"name": "João Souza",
"email": "joao@example.com",
"document": "987.654.321-00",
"birthdate": "1985-03-20",
"monthly_income": 300000,
"professional_occupation": "Director",
"self_declared_legal_representative": True,
"address": {
"street": "Av. Paulista",
"complementary": "Sala 5",
"street_number": "1000",
"neighborhood": "Bela Vista",
"city": "São Paulo",
"state": "SP",
"zip_code": "01311100",
"reference_point": "Próximo ao metrô"
},
"phone_numbers": [
{
"ddd": "11",
"number": "999999999"
}
]
}
]
}
}
] }
headers = {
"x-client-id": "<x-client-id>",
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-client-id': '<x-client-id>',
'X-API-Key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
gateways: [
{
gateway_slug: 'pagarme',
secret_key: 'sk_live_abc123',
order: 1,
client_id: 'client_xyz',
use_as_subaccount: false,
subaccount_information: {
name: 'Maria Silva',
trading_name: 'Loja da Maria',
email: 'maria@example.com',
document: '123.456.789-00',
type: 'individual',
annual_revenue: 120000,
company_type: 'LTDA',
birthdate: '1990-06-15',
monthly_income: 500000,
professional_occupation: 'Software Engineer',
phone_numbers: [{country: 'BR', number: '999999999', type: 'mobile'}],
address: {
street: 'Rua das Flores',
complementary: 'Apto 101',
number: '123',
neighborhood: 'Centro',
city: 'São Paulo',
state: 'SP',
zip_code: '01310-100'
},
default_bank_account: {
holder_name: 'Maria Silva',
holder_type: 'individual',
holder_document: '123.456.789-00',
bank_code: '341',
branch_number: '0001',
account_number: '12345678',
account_check_digit: '9',
type: 'checking'
},
managing_partners: [
{
name: 'João Souza',
email: 'joao@example.com',
document: '987.654.321-00',
birthdate: '1985-03-20',
monthly_income: 300000,
professional_occupation: 'Director',
self_declared_legal_representative: true,
address: {
street: 'Av. Paulista',
complementary: 'Sala 5',
street_number: '1000',
neighborhood: 'Bela Vista',
city: 'São Paulo',
state: 'SP',
zip_code: '01311100',
reference_point: 'Próximo ao metrô'
},
phone_numbers: [{ddd: '11', number: '999999999'}]
}
]
}
}
]
})
};
fetch('http://localhost:7701/api/v1/company/gateways', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "7701",
CURLOPT_URL => "http://localhost:7701/api/v1/company/gateways",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'gateways' => [
[
'gateway_slug' => 'pagarme',
'secret_key' => 'sk_live_abc123',
'order' => 1,
'client_id' => 'client_xyz',
'use_as_subaccount' => false,
'subaccount_information' => [
'name' => 'Maria Silva',
'trading_name' => 'Loja da Maria',
'email' => 'maria@example.com',
'document' => '123.456.789-00',
'type' => 'individual',
'annual_revenue' => 120000,
'company_type' => 'LTDA',
'birthdate' => '1990-06-15',
'monthly_income' => 500000,
'professional_occupation' => 'Software Engineer',
'phone_numbers' => [
[
'country' => 'BR',
'number' => '999999999',
'type' => 'mobile'
]
],
'address' => [
'street' => 'Rua das Flores',
'complementary' => 'Apto 101',
'number' => '123',
'neighborhood' => 'Centro',
'city' => 'São Paulo',
'state' => 'SP',
'zip_code' => '01310-100'
],
'default_bank_account' => [
'holder_name' => 'Maria Silva',
'holder_type' => 'individual',
'holder_document' => '123.456.789-00',
'bank_code' => '341',
'branch_number' => '0001',
'account_number' => '12345678',
'account_check_digit' => '9',
'type' => 'checking'
],
'managing_partners' => [
[
'name' => 'João Souza',
'email' => 'joao@example.com',
'document' => '987.654.321-00',
'birthdate' => '1985-03-20',
'monthly_income' => 300000,
'professional_occupation' => 'Director',
'self_declared_legal_representative' => true,
'address' => [
'street' => 'Av. Paulista',
'complementary' => 'Sala 5',
'street_number' => '1000',
'neighborhood' => 'Bela Vista',
'city' => 'São Paulo',
'state' => 'SP',
'zip_code' => '01311100',
'reference_point' => 'Próximo ao metrô'
],
'phone_numbers' => [
[
'ddd' => '11',
'number' => '999999999'
]
]
]
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>",
"x-client-id: <x-client-id>"
],
]);
$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 := "http://localhost:7701/api/v1/company/gateways"
payload := strings.NewReader("{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-client-id", "<x-client-id>")
req.Header.Add("X-API-Key", "<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.put("http://localhost:7701/api/v1/company/gateways")
.header("x-client-id", "<x-client-id>")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:7701/api/v1/company/gateways")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["x-client-id"] = '<x-client-id>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"gateways\": [\n {\n \"gateway_slug\": \"pagarme\",\n \"secret_key\": \"sk_live_abc123\",\n \"order\": 1,\n \"client_id\": \"client_xyz\",\n \"use_as_subaccount\": false,\n \"subaccount_information\": {\n \"name\": \"Maria Silva\",\n \"trading_name\": \"Loja da Maria\",\n \"email\": \"maria@example.com\",\n \"document\": \"123.456.789-00\",\n \"type\": \"individual\",\n \"annual_revenue\": 120000,\n \"company_type\": \"LTDA\",\n \"birthdate\": \"1990-06-15\",\n \"monthly_income\": 500000,\n \"professional_occupation\": \"Software Engineer\",\n \"phone_numbers\": [\n {\n \"country\": \"BR\",\n \"number\": \"999999999\",\n \"type\": \"mobile\"\n }\n ],\n \"address\": {\n \"street\": \"Rua das Flores\",\n \"complementary\": \"Apto 101\",\n \"number\": \"123\",\n \"neighborhood\": \"Centro\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01310-100\"\n },\n \"default_bank_account\": {\n \"holder_name\": \"Maria Silva\",\n \"holder_type\": \"individual\",\n \"holder_document\": \"123.456.789-00\",\n \"bank_code\": \"341\",\n \"branch_number\": \"0001\",\n \"account_number\": \"12345678\",\n \"account_check_digit\": \"9\",\n \"type\": \"checking\"\n },\n \"managing_partners\": [\n {\n \"name\": \"João Souza\",\n \"email\": \"joao@example.com\",\n \"document\": \"987.654.321-00\",\n \"birthdate\": \"1985-03-20\",\n \"monthly_income\": 300000,\n \"professional_occupation\": \"Director\",\n \"self_declared_legal_representative\": true,\n \"address\": {\n \"street\": \"Av. Paulista\",\n \"complementary\": \"Sala 5\",\n \"street_number\": \"1000\",\n \"neighborhood\": \"Bela Vista\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zip_code\": \"01311100\",\n \"reference_point\": \"Próximo ao metrô\"\n },\n \"phone_numbers\": [\n {\n \"ddd\": \"11\",\n \"number\": \"999999999\"\n }\n ]\n }\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": 1,
"company_id": 42,
"gateway_id": 1,
"gateway_slug": "pagarme",
"client_id": null,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
]
}Authorizations
Company API key. Send in the X-API-Key header.
Headers
Client identifier for the company in the request.
Example:
"client_abc123"
Body
application/json
Show child attributes
Show child attributes
Response
Gateway credentials saved
Show child attributes
Show child attributes