PayZu OnboardingPropostasCriação e consulta

Listar as propostas

GET/v1/proposals

Confira o passo a passo → https://docs.payzu.com.br/docs/onboarding/list-proposals


Query Params

limitintegerPadrão: 100
Itens por página.
cursorstring
Valor de nextCursor da página anterior.
statusarray of strings
Filtra por um ou vários status da proposta.

Headers

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

Responses

200Lista de propostas
itemsarray of objectsPropostas da página, das mais novas.
Campos de cada item 13
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.
nextCursorstring | nullCursor da próxima página; nulo encerra a lista.
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.

Linguagem

Credenciais Bearer

Token de API

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