PayZu OnboardingPropostasCriação e consulta

Criar uma proposta de abertura de conta

POST/v1/proposals

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


O cliente preenche a proposta na jornada, e a PayZu analisa.

Body Params

clientCodestringobrigatório
Seu identificador. Se repetir, retorna a proposta já criada.
typestring enumobrigatório
Tipo de pessoa da proposta.PERSONCOMPANY
taxIdstringobrigatório
CPF ou CNPJ do titular da proposta.
contactstring
Celular ou e-mail do titular.
expiresInHoursinteger
Horas até a proposta expirar.
prefillobject
Dados já conhecidos, gravados junto com a criação.
metadataobject
Seus dados livres, guardados na proposta.
embedobject
Página ou app que vai exibir a jornada embutida.
callbackUrlstring
URL que recebe os eventos de webhook desta proposta.

Headers

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

Responses

200Proposta já existente
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.
journeyUrlstring | nullLink da jornada por link, retornado só na criação.
embedUrlstring | nullURL da jornada embutida, retornada só na criação.
201Proposta criada
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.
journeyUrlstring | nullLink da jornada por link, retornado só na criação.
embedUrlstring | nullURL da jornada embutida, retornada só na criação.
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.
409Estado ou versão em conflito
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.
422Operação recusada
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.
503Serviço indisponível
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 POST \     --url https://api.sandbox.payzu.dev/v1/proposals \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json' \     --header 'content-type: application/json' \     --data '{}'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json