Sobre o PayZu Onboarding
Nesta página
Como funcionaO que você consegue fazerO que você precisaRegras que valem para todas as chamadasPróximos passosAbra 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
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
Crie, consulte pelo ID, pelo seu identificador ou pelo documento, liste e cancele.
Links da jornadaEntregue o link ao cliente e gere outro quando ele se perder.
Jornada embutidaMostre a jornada na sua página ou no seu app.
Jornada e etapasAcompanhe em que etapa o cliente está.
DocumentosLeia os documentos que o cliente enviou.
Envio e análiseAcompanhe a análise até a decisão.
CallbacksReceba cada mudança no seu backend.
O que você precisa
| Para | Você precisa de |
|---|---|
| Chamar a API | Uma conta de serviço Google do seu backend, autorizada pela PayZu no seu tenant. Veja Autenticação. |
| Receber callbacks | Uma URL https pública, cadastrada pela PayZu no seu tenant junto com o segredo que assina as entregas. Veja Callbacks. |
| Testar | O 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
| Regra | Como funciona |
|---|---|
| Seu identificador | clientCode 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ência | As 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ção | cursor 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. |
| Documentos | CPF 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. |
| Fuso | Datas e horas em UTC, no formato ISO 8601, como 2026-09-17T12:00:00.000Z. |
| Erros | Corpo application/problem+json. Decida pelo code, nunca pelo texto. Veja Erros. |
| Servidores | Sandbox 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. |