Conceitos Fundamentais

Antes de escrever a primeira linha de código, fixe o vocabulário. Esta página define as entidades que você verá em toda a documentação.

Entidades

Entidade	O que é	Identificador (UUID)
Marketplace	O cliente da Zoop.	`marketplace_id`
Onboarding	A jornada de credenciamento — a proposta que você submete para aprovação de um Profile/Vendedor.	`onboarding_id`
Profile	A entidade consolidada que nasce quando o onboarding é aprovado. É o que você gerencia no longo prazo.	`profile_id`
Conta de Pagamento	A conta regulatória (com reporte ao CCS/BC) onde o saldo fica custodiado. Criada automaticamente.	`account_id`
Seller	Chave para ser utilizada nos fluxos transacionais.	`seller_id`

Tipo	Valor	Descrição
Pessoa Física	`INDIVIDUAL`	CPF, documento de identidade + selfie
Pessoa Jurídica	`BUSINESS`	CNPJ, contrato social/CCMEI + sócio responsável

Importante | Payloads
PF e PJ têm payloads diferentes. No credenciamento, use type para indicar qual.

Dois conceitos que se confundem:

Conta de Pagamento (account_id) — onde o saldo fica custodiado dentro da Zoop. Criada automaticamente no credenciamento.
Conta externa de destino (external_bank_account) — a conta bancária (fora da Zoop) para onde o saldo é transferido no repasse (funds-out). Você informa os dados (banco, agência, conta) e a Zoop valida a titularidade.

O Zoop BaaS usa status em UPPER_SNAKE_CASE. Dois ciclos de vida importam:

Onboarding: STARTED → WAITING_REQUIRED_DOCUMENTS →WAITING_APPROVAL_REQUEST → UNDER_ANALYSIS → APPROVED | REJECTED
Profile: PENDING →ENABLED → CANCELLED | PENDING →DENIED

Para mais informações, consulte a página dos Estados do Credenciamento.