PayZu OnboardingPropostas

Links da jornada


Nesta páginaEntregue o linkGere outro linkSaiba se o cliente abriu o linkErros desta operação

Leve o cliente à jornada de cadastro com o link que a criação da proposta retorna, entregue pelo seu canal.

A criação retorna o link em journeyUrl, uma vez só. Guarde-o e entregue ao cliente pelo canal que você já usa com ele, como app, e-mail ou mensagem. O link abre até o expiresAt da proposta.

Nenhuma consulta retorna o link de novo.

Se o link guardado se perdeu, gere outro.

bash
curl --request POST \
  --url 'https://api.sandbox.payzu.dev/v1/proposals/cmvb8kz7q0001s60a4hzf6j2t/actions/issue-link' \
  --header 'Authorization: Bearer SEU_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

A resposta traz a proposta com o link novo em journeyUrl.

Referência: Gerar um link da jornada

  • Link anterior: para de abrir na hora, inclusive numa aba já aberta.
  • expectedVersion: opcional, com a version da sua última leitura.
  • embed: não é aceito na jornada por link. A jornada embutida tem regras próprias, em Gerar outro link embutido.
Situação da propostaA emissão
Em preenchimentoGera o link.
Em análiseResponde proposal_not_editable.
EncerradaResponde proposal_not_open.
Prazo vencidoResponde proposal_expired.

Não há callback para link aberto: o rastro de Consultar a jornada mostra até onde o cliente foi. A proposta passa a IN_PROGRESS quando o cliente confirma o código ou conclui a primeira etapa.

Erros desta operação

CódigoHTTPMensagem
proposal_not_found404Proposta não encontrada.
proposal_not_editable409A proposta está em análise ou decidida e não aceita alterações agora.
proposal_not_open409A proposta já foi decidida, expirou ou foi cancelada.
version_conflict409O registro mudou desde a leitura. Releia e tente de novo.
proposal_expired410O prazo da proposta venceu.

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