PayZu OnboardingPropostasAcompanhamento
Gerar um link da jornada
POST/v1/proposals/{id}/actions/issue-link
Confira o passo a passo → https://docs.payzu.com.br/docs/onboarding/journey-links
Requisições recentes
Path Params
idstringobrigatório
ID da proposta.
Body Params
embedobject
Muda o destino para outra página ou app cadastrado.
expectedVersioninteger
Versão da proposta que você leu por último.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Link emitido
idstringID da proposta.
clientCodestringSeu identificador, enviado na criação.
typestringTipo de pessoa da proposta.
PERSONCOMPANYtaxIdstring | nullCPF ou CNPJ do titular da proposta.
contactstring | nullCelular ou e-mail do titular.
statusstringStatus da proposta.
CREATEDIN_PROGRESSSUBMITTEDIN_ANALYSISWAITING_DATAAPPROVEDREPROVEDEXPIREDCANCELEDdeliverystringComo o titular entra na jornada: por link ou embutida.
LINKEMBEDDEDexpiresAtstringData e hora em que a proposta expira.
submittedAtstring | nullData e hora do envio para análise.
decidedAtstring | nullData e hora da decisão.
versionintegerVersão atual; envie em expectedVersion.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
journeyUrlstring | nullLink novo da jornada por link.
embedUrlstring | nullURL nova da jornada embutida. Ela só aparece nesta resposta.
400Requisição inválida
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
401Token ausente ou inválido
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
403Acesso negado
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
404Proposta não encontrada
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
409Estado ou versão em conflito
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
currentVersionintegerVersão vigente, quando o erro é version_conflict.
410Proposta vencida
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
503Serviço indisponível
typestringIdentifica o tipo do erro.
titlestringResumo curto do erro.
statusintegerO mesmo status HTTP da resposta.
detailstringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
requestIdstringInforme este id ao suporte para localizar a chamada.
errorsarray of objectsErros de validação por campo.
Campos de cada item 3
patharray of stringsCaminho até o campo rejeitado.
codestringCódigo da falha de validação.
messagestringMotivo da rejeição.
Esta página ajudou?