PayZu OnboardingPropostas
Consultar a jornada
Descubra até onde o cliente foi na jornada, por exemplo para lembrar quem parou no meio.
Veja onde o cliente está
bash
curl --url 'https://api.sandbox.payzu.dev/v1/proposals/cmvb8kz7q0001s60a4hzf6j2t/journey' \
--header 'Authorization: Bearer SEU_TOKEN'json
{
"proposalId": "cmvb8kz7q0001s60a4hzf6j2t",
"status": "IN_PROGRESS",
"currentStep": "MEMBERS",
"steps": [
{
"step": "CONTACT_VERIFICATION",
"type": "CONTACT_VERIFICATION",
"position": 1,
"status": "DONE",
"startedAt": "2026-10-16T18:40:12.000Z",
"completedAt": "2026-10-16T18:40:12.000Z"
},
{
"step": "COMPANY_DATA",
"type": "COMPANY_DATA",
"position": 2,
"status": "DONE",
"startedAt": "2026-10-16T18:40:12.000Z",
"completedAt": "2026-10-16T18:52:41.000Z"
},
{
"step": "MEMBERS",
"type": "MEMBERS",
"position": 3,
"status": "IN_PROGRESS",
"startedAt": "2026-10-16T18:52:41.000Z",
"completedAt": null
}
]
}O exemplo é de uma proposta de empresa no quadro societário.
Referência: Consultar a jornada de uma proposta
| Campo | O que traz |
|---|---|
currentStep | A primeira etapa aberta entre as de steps[], ou null quando nenhuma está aberta. |
steps[].status | O andamento da etapa, com os valores de Jornada e etapas. |
steps[].startedAt | O início da etapa. |
steps[].completedAt | O fim da etapa. |
O rastro não tem callback próprio.
Consulte quando precisar saber até onde o cliente foi.
Erros desta operação
| Código | HTTP | Mensagem |
|---|---|---|
proposal_not_found | 404 | Proposta não encontrada. |
Autenticação e validação estão no Catálogo de erros.