Referência de organizações
Obter uma organização
Retorna uma organização pelo ID.
Retorna o objeto
O exemplo abaixo mostra uma organização em análise (
organization completo.
Os campos financeiros (activation_status, activation_status_updated_at, activation_submitted_at, requirements e statement_descriptor) e a marca (branding_settings) estão sempre presentes. Os campos platform e metadata descrevem a relação entre a plataforma autenticada e a organização conectada.
Autenticação
A organização vem do
{id} da URL. Não envie o header Organization: o
vínculo ativo é validado usando a plataforma da chave e o ID do caminho. API
keys de organizações padrão não acessam esta rota.Parâmetros de caminho
Resposta
Marca da organização nas páginas do comprador — checkout, confirmação da
compra, fatura hospedada e portal do cliente — e no botão dos e-mails ao
comprador. Traz
appearance, com as seis escolhas de aparência
(background_color, button_color, font, gray_color,
style e theme), ou appearance: null quando a organização segue a
aparência da plataforma. Mostra só o que a organização salvou; a aparência
herdada não aparece. Marca do rodapé, domínio próprio e a escolha de
quem apresenta a venda são configurados no Dashboard e não aparecem na API.
Formato completo em Objeto Organization.Perfil de negócio declarado:
annual_revenue (amount em centavos, a menor unidade da moeda, e currency), mcc, url. null
até algum dado existir.Dados cadastrais da empresa (CNPJ):
address, email, name,
opening_date, phone, trade_name. null em organizações CPF ou antes da
coleta.Pessoa física titular (CPF):
address, birthdate, document, email,
first_name, last_name, phone. null em organizações CNPJ ou antes da
coleta.Representante legal (CNPJ), mesmo formato de
individual. null em
organizações CPF ou antes da coleta.Conta para saques ativa conectada à organização. Use este campo para exibir
banco, agência/roteamento, titular e últimos 4 dígitos no admin da plataforma.
null quando não há conta conectada. O número completo da conta nunca é
retornado.Lista de tarefas da ativação financeira:
disabled_reason, errors,
missing e pending_verification. Sempre presente; em organização active,
tudo vazio. Veja o formato completo em O objeto
Organization e o fluxo de correção em
Requisitos de ativação.Status financeiro da organização. Sempre presente. Em
disabled, requirements explica o motivo e a organização pode iniciar uma nova tentativa de ativação.Nome exibido na fatura do comprador. Compartilhado entre organizações com o
mesmo CPF/CNPJ;
null antes do primeiro envio do cadastro.Metadata da relação entre a plataforma autenticada e a organização conectada.
{} quando vazia.in_review): requirements.pending_verification lista o que está sendo verificado.

