PayZu OnboardingPropostasCriação e consulta

Consultar uma proposta

GET/v1/proposals/lookup

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


Query Params

idstring
ID da proposta.
clientCodestring
Seu identificador, enviado na criação.
taxIdstring
CPF ou CNPJ do titular. Retorna a proposta mais recente do documento.

Headers

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

Responses

200Proposta encontrada
idstringID da proposta.
clientCodestringSeu identificador, enviado na criação.
typestringTipo de pessoa da proposta.
PERSONCOMPANY
taxIdstring | nullCPF ou CNPJ do titular da proposta.
contactstring | nullCelular ou e-mail do titular.
statusstringStatus da proposta.
CREATEDIN_PROGRESSSUBMITTEDIN_ANALYSISWAITING_DATAAPPROVEDREPROVEDEXPIREDCANCELED
deliverystringComo o titular entra na jornada: por link ou embutida.
LINKEMBEDDED
expiresAtstringData 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.
metadataobject | nullSeus dados livres, guardados na proposta.
contactVerifiedAtstring | nullData e hora em que o contato foi confirmado.
stepsarray of objectsEtapas da jornada, na ordem.
Campos de cada item 7
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
reasonCodesarray of stringsMotivos da reabertura.
startedAtstring | nullData e hora do início da etapa.
completedAtstring | nullData e hora da conclusão da etapa.
documentsarray of objectsDocumentos enviados na proposta.
Campos de cada item 8
idstringID do documento.
typestringTipo do documento.
sourcestringSe o arquivo foi enviado ou veio da captura.
UPLOADPROVIDER
statusstringStatus do documento.
AWAITING_UPLOADAVAILABLEREJECTED
rejectionReasonCodestring | nullMotivo da recusa, do catálogo de motivos.
mimeTypestringTipo MIME do arquivo.
sizeBytesinteger | nullTamanho do arquivo em bytes.
createdAtstringData e hora do registro.
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.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.sandbox.payzu.dev/v1/proposals/lookup \     --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