PayZu Onboarding

Sobre o PayZu Onboarding


Nesta páginaComo funcionaO que você consegue fazerO que você precisaRegras que valem para todas as chamadasPróximos passos

Abra contas para os clientes da sua empresa, pessoas físicas e empresas, a partir de uma proposta que a sua aplicação cria e que a PayZu analisa e decide.

Como funciona

Fluxo do PayZu Onboarding: a sua aplicação cria a proposta, o cliente faz a jornada, a PayZu analisa e decide, e o seu backend recebe o callback

Sua aplicação cria a proposta e recebe o link da jornada. Você entrega o link ao cliente pelo seu canal ou mostra a jornada na sua página ou no seu app.

Na jornada, o cliente confirma o contato, preenche os dados, envia os documentos e faz a captura de documento e selfie. O seu backend recebe um callback no envio, no pedido de dados, na decisão e no encerramento.

O que você consegue fazer

O que você precisa

ParaVocê precisa de
Chamar a APIUma conta de serviço Google do seu backend, autorizada pela PayZu no seu tenant. Veja Autenticação.
Receber callbacksUma URL https pública, cadastrada pela PayZu no seu tenant junto com o segredo que assina as entregas. Veja Callbacks.
TestarO sandbox, em https://api.sandbox.payzu.dev. Veja Primeiros passos.

Não há segredo compartilhado.

O ID token da conta de serviço é trocado pelo token da API.

Regras que valem para todas as chamadas

RegraComo funciona
Seu identificadorclientCode leva um código seu, com até 120 caracteres e único no tenant. Ele também recupera a proposta depois de uma falha de rede, como mostra Criar uma proposta.
ConcorrênciaAs ações que mudam estado recebem em expectedVersion a version da sua última leitura. Se a proposta mudou, a resposta traz a versão vigente em currentVersion.
Paginaçãocursor recebe o nextCursor da página anterior, que vem nulo quando a lista acaba. Cada página traz até 100 itens, dos mais novos para os mais antigos.
DocumentosCPF em PERSON e CNPJ em COMPANY, com ou sem pontuação. A PayZu retorna só os dígitos, com o CNPJ alfanumérico em maiúsculas.
FusoDatas e horas em UTC, no formato ISO 8601, como 2026-09-17T12:00:00.000Z.
ErrosCorpo application/problem+json. Decida pelo code, nunca pelo texto. Veja Erros.
ServidoresSandbox https://api.sandbox.payzu.dev e produção https://api.payzu.dev, sem prefixo: as rotas da API começam em /v1, e o token fica em /oauth/token.

Próximos passos