PayZu OnboardingPropostas

Criar uma proposta


Nesta páginaCrie a propostaCamposRepita depois de uma falha de redeErros desta operação

Abra pela sua aplicação o pedido de abertura de conta de um CPF ou CNPJ e receba o link da jornada para entregar ao cliente.

Crie a proposta

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

Guarde o link que a criação retorna.

Ele vem em journeyUrl uma vez só, e você o entrega ao cliente pelo seu canal, como mostra Links da jornada.

Campos

CampoRegra
clientCodeObrigatório. Um identificador seu, com até 120 caracteres e único no tenant.
typeObrigatório. PERSON ou COMPANY.
taxIdObrigatório. CPF em PERSON e CNPJ em COMPANY; documento que não combina com o tipo responde validation_failed.
contactCelular ou e-mail do cliente, que ele confirma na jornada.
expiresInHoursPrazo para o cliente concluir.
prefillDados do cliente que você já tem. A jornada abre com eles preenchidos, como em Cenários práticos.
embedMostra a jornada na sua página ou no seu app, e o link vem em embedUrl. Veja Jornada embutida.
callbackUrlSó é aceita depois que a PayZu cadastrou o segredo dos callbacks do seu tenant.

Repita depois de uma falha de rede

Mande de novo o mesmo clientCode com o mesmo corpo. A resposta é 200 com a proposta existente, e journeyUrl e embedUrl vêm nulos.

  • Corpo diferente: a criação é recusada com client_code_conflict. expiresInHours não entra nessa comparação.
  • Link novo: use Gerar um link da jornada.
  • Nova tentativa do mesmo cliente: gere outro clientCode.

Erros desta operação

CódigoHTTPMensagem
callback_url_invalid400A URL de callback precisa ser https, pública e sem credenciais.
embed_origin_not_allowed400A origem não está entre as páginas autorizadas a embutir a jornada deste tenant.
embed_return_url_not_allowed400A URL de retorno não está entre as cadastradas para o app deste tenant.
client_code_conflict409O clientCode já foi usado com outro conteúdo.
journey_incomplete409conclua COMPANY_DATA antes de MEMBERS
journey_step_not_open409Esta etapa não está aberta para envio.
write_conflict409Outra requisição gravou o mesmo recurso ao mesmo tempo. Releia e tente de novo.
contact_channel_unsupported422O tenant confirma o contato por celular ou por e-mail; informe um contato desse tipo.
embed_unavailable503O serviço não consegue assinar links embutidos neste ambiente.

Autenticação e validação estão no Catálogo de erros.