PayZu OnboardingPropostas
Consultar uma proposta
Confira o status de uma proposta quando um callback não chegar ou antes de agir sobre ela.
Consulte a proposta
bash
curl --url 'https://api.sandbox.payzu.dev/v1/proposals/lookup?id=cmf0p8x1a0001qk08prop0001' \
--header 'Authorization: Bearer SEU_TOKEN'json
{
"id": "cmf0p8x1a0001qk08prop0001",
"clientCode": "crm-8812",
"type": "PERSON",
"taxId": "12345678909",
"contact": "5573991699000",
"status": "CREATED",
"delivery": "LINK",
"expiresAt": "2026-09-20T12:00:00.000Z",
"submittedAt": null,
"decidedAt": null,
"version": 0,
"createdAt": "2026-09-17T12:00:00.000Z",
"updatedAt": "2026-09-17T12:00:00.000Z",
"metadata": null,
"contactVerifiedAt": null,
"steps": [
{
"step": "CONTACT_VERIFICATION",
"type": "CONTACT_VERIFICATION",
"position": 1,
"status": "PENDING",
"reasonCodes": [],
"startedAt": null,
"completedAt": null
},
{
"step": "PERSONAL_DATA",
"type": "PERSONAL_DATA",
"position": 2,
"status": "PENDING",
"reasonCodes": [],
"startedAt": null,
"completedAt": null
}
],
"documents": []
}O exemplo omite as etapas depois de PERSONAL_DATA.
Referência: Consultar uma proposta
Escolha o identificador
Informe só um dos três.
| Parâmetro | Retorna |
|---|---|
id | A proposta com esse ID. |
clientCode | A proposta que você criou com esse identificador. |
taxId | A proposta mais recente do CPF ou CNPJ do titular. |
Nenhuma consulta retorna o link da jornada.
Se ele se perdeu, gere outro em Links da jornada.
O que cada status pede de você está em Propostas, as etapas de steps[], em Jornada e etapas, e documents[], em Documentos.
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.