PayZu OnboardingPropostasAcompanhamento

Consultar a jornada de uma proposta

GET/v1/proposals/{id}/journey

Confira o passo a passo → https://docs.payzu.com.br/docs/onboarding/get-the-journey


Path Params

idstringobrigatório
ID da proposta.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Rastro da jornada
proposalIdstringID da proposta.
statusstringStatus da proposta.
CREATEDIN_PROGRESSSUBMITTEDIN_ANALYSISWAITING_DATAAPPROVEDREPROVEDEXPIREDCANCELED
currentStepstring | nullEtapa atual da jornada.
stepsarray of objectsEtapas da jornada, na ordem.
Campos de cada item 6
stepstringID da etapa, que por padrão é o tipo.
typestringTipo da etapa.
CONTACT_VERIFICATIONPERSONAL_DATAADDRESSCOMPANY_DATAMEMBERSDOCUMENTSFACECOMPLIANCE_QUESTIONSTERMS
positionintegerPosição da etapa na jornada.
statusstringStatus da etapa.
PENDINGIN_PROGRESSDONESKIPPEDREOPENED
startedAtstring | nullData e hora do início da etapa.
completedAtstring | nullData e hora da conclusão da etapa.
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.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/proposals/{id}/journey \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json