PayZu Onboarding

Primeiros passos


Nesta páginaAutorize a conta de serviçoPeça o tokenCrie a primeira propostaPercorra a jornadaO que vem depois

Chegue à primeira proposta no sandbox com um token válido e o link da jornada pronto para o cliente.

Autorize a conta de serviço

A API não usa segredo compartilhado. Envie à PayZu o e-mail e o uniqueId da conta de serviço Google do seu backend, e ela cadastra a autorização dessa conta no seu tenant, uma para o sandbox e outra para a produção.

De cada ambiente você recebe dois valores:

  • Audiência do ID token: a conta de serviço pede o ID token ao Google com ela.
  • Id do seu tenant: vai em audience na troca do token.
AmbienteServidor
Sandboxhttps://api.sandbox.payzu.dev
Produçãohttps://api.payzu.dev

O servidor não leva prefixo: as rotas da API começam em /v1, e o token fica na raiz, em /oauth/token.

As rotas e os corpos são os mesmos nos dois ambientes.

Para ir à produção, troque o servidor e use a autorização, a audience e o destino dos callbacks cadastrados para ela.

Peça o token

Gere o ID token no seu backend com a biblioteca de autenticação do Google e mande-o em subject_token, sem o cabeçalho Authorization, que a rota não aceita.

bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/oauth/token' \
  --header 'Content-Type: application/json' \
  --data '{
    "grant_type": "urn:ietf:params:oauth:grant-type:token-exchange",
    "subject_token_type": "urn:ietf:params:oauth:token-type:id_token",
    "subject_token": "eyJhbGciOiJSUzI1NiIs...",
    "audience": "payzu"
  }'

Referência: Gerar um token de acesso

O token vale expires_in segundos, 15 minutos no exemplo. Nas outras rotas, mande Authorization: Bearer SEU_TOKEN e reaproveite o mesmo token até perto de vencer, como explica Autenticação.

Crie a primeira proposta

Identifique a proposta com um código seu em clientCode e informe o tipo de titular e o documento. O cliente confirma o contact na jornada e tem expiresInHours horas para concluir.

bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/v1/proposals' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientCode": "crm-8812",
    "type": "PERSON",
    "taxId": "123.456.789-09",
    "contact": "+55 73 99169-9000",
    "expiresInHours": 72
  }'

Referência: Criar uma proposta de abertura de conta

A proposta nasce CREATED, com version 0. Entregue o journeyUrl ao cliente pelo seu canal.

Guarde o link que a criação retorna.

Guarde também o id. Nenhuma consulta retorna o link, e repetir a criação responde com journeyUrl nulo. Se ele se perder, emita outro em Gerar um link da jornada.

Para testar sem escrever código, abra a rota na referência, cole o token e use o Try It!.

Percorra a jornada

Abra o journeyUrl no navegador, confirme o contato com o código 000000, preencha as telas e envie. Depois, veja o status em Consultar uma proposta.

No sandbox, a consulta cadastral responde com dados de teste.

DocumentoResultado da análise
000.000.001-91Reprova.
390.533.447-05Fica em IN_ANALYSIS até a decisão.
Os demaisAprovam quando o nome e o nascimento batem com os dados de teste.