PayZu OnboardingPropostasAcompanhamento

Listar os arquivos de uma proposta

GET/v1/proposals/{id}/files

Confira o passo a passo → https://docs.payzu.com.br/docs/onboarding/documents


Path Params

idstringobrigatório
ID da proposta.

Headers

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

Responses

200Arquivos disponíveis
proposalIdstringID da proposta.
filesarray of objectsDocumentos disponíveis, com link de leitura.
Campos de cada item 10
idstringID do arquivo.
typestringTipo do documento.
sourcestringSe o arquivo foi enviado ou veio da captura.
UPLOADPROVIDER
ownerobjectDono do arquivo: a pessoa (titular, quem preencheu ou sócio) ou a empresa.
Campos do objeto 2
taxIdstringCPF ou CNPJ do dono.
namestringNome do dono.
mimeTypestringTipo MIME do arquivo.
sizeBytesinteger | nullTamanho do arquivo em bytes.
sha256string | nullHash do conteúdo, gravado na conferência.
createdAtstringData e hora do registro.
urlstringLink assinado para ler o arquivo.
expiresAtstringData e hora em que o link expira.
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}/files \     --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