PayZu PixDevolução Pix

Solicitar a devolução de um Pix recebido

POST/refund/{transactionId}

Confira o passo a passo → https://docs.payzu.com.br/docs/pix/refund-a-pix


Path Params

transactionIdstringobrigatório
ID da transação a devolver.

Body Params

amountnumber
Valor a devolver.
descriptionstring
Descrição da devolução.
clientReferencestring
Seu identificador. Se repetir, retorna a devolução já criada.

Headers

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

Responses

200Devolução enfileirada
idstringIdentificador da transação na PayZu.
statusstringStatus da transação.
PENDINGCOMPLETEDCANCELEDWAITING_FOR_REFUNDREFUNDEDEXPIREDERROR
amountnumberValor em reais, antes da tarifa.
typestringTipo da transação.
DEPOSITWITHDRAWCOMMISSIONLIQUIDATIONADJUSTMENT
qrCodeTextstring | nullCódigo Pix copia e cola.
qrCodeBase64string | nullImagem PNG do QR Code em base64, sem prefixo.
qrCodeUrlstring | nullRota autenticada que retorna o PNG do QR Code.
generatedNamestring | nullNome usado na cobrança.
generatedDocumentstring | nullCPF ou CNPJ usado na cobrança.
generatedEmailstring | nullE-mail usado na cobrança.
payerNamestring | nullTitular da conta que pagou.
payerDocumentstring | nullCPF ou CNPJ de quem pagou.
payerInstitutionIspbstring | nullISPB da instituição de origem.
payerInstitutionNamestring | nullInstituição de origem do Pix.
payerAccountNumberstring | nullConta PayZu do pagador.
serviceFeeChargednumber | nullTarifa PayZu, que pode ter mais de 2 casas decimais.
withdrawPixKeystring | nullChave de destino do saque, normalizada.
withdrawPixTypestring | nullTipo da chave de destino (evp é a chave aleatória).
cpfcnpjemailphoneevp
receiverNamestring | nullTitular da conta que recebe.
receiverDocumentstring | nullCPF ou CNPJ de quem recebe.
receiverInstitutionIspbstring | nullISPB da instituição de destino.
receiverInstitutionNamestring | nullInstituição de destino do Pix.
receiverAccountNumberstring | nullConta PayZu do recebedor.
endToEndIdstring | nullID end-to-end do Pix.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
paidAtstring | nullData e hora da liquidação.
clientReferencestring | nullSeu identificador, enviado na criação.
refundEndToEndIdstring | nullID end-to-end da devolução.
refundAmountnumber | nullValor devolvido.
refundStatusstring | nullStatus da devolução.
PENDINGCOMPLETEDCANCELED
refundReasonstring | nullMotivo: seu pedido, MED, depósito de CNPJ recusado ou ação da PayZu.
CUSTOMER_REQUESTINFRACTIONDENY_COMPANY_DEPOSITADMIN_REQUEST
refundDescriptionstring | nullDescrição da devolução.
refundedAtstring | nullData e hora da devolução.
cancellationReasonstring | nullMotivo do cancelamento.
virtualAccountstring | nullSubconta informada na criação.
methodstringMeio de pagamento.
PIXINTERNAL_TRANSFERBANK_SLIPTED
refundsarray of objectsDevoluções da transação, da mais recente à mais antiga.
Campos de cada item 9
idstringIdentificador da devolução.
amountnumberValor devolvido.
reasonstringMotivo: seu pedido, MED, depósito de CNPJ recusado ou ação da PayZu.
CUSTOMER_REQUESTINFRACTIONDENY_COMPANY_DEPOSITADMIN_REQUEST
descriptionstring | nullDescrição da devolução.
statusstringStatus da devolução.
PENDINGCOMPLETEDCANCELED
endToEndIdstring | nullID end-to-end da devolução.
refundedAtstring | nullData e hora da devolução.
createdAtstringData e hora do pedido de devolução.
updatedAtstringData e hora da última alteração.
400Requisição inválida
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
detailsarray of objectsErros de validação por campo.
Campos de cada item 2
fieldstringCampo rejeitado.
messagestringMotivo da rejeição.
401Token ausente ou inválido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
403Acesso negado
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
404Transação não encontrada
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
409Devolução duplicada
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
422Devolução recusada
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
424Falha na instituição financeira
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
429Limite de requisições atingido
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.
retryAfterSecondsintegerSegundos de espera antes de tentar de novo.
500Erro interno
statusstringSempre ERROR.
errorstringNome do status HTTP.
errorCodestringCódigo do erro, como PZV001.
messagestringMotivo em texto, para exibir ou registrar.
statusCodeintegerO mesmo status HTTP da resposta.
requestIdstringInforme este id ao suporte para localizar a chamada.

Linguagem

Credenciais Bearer

Token de API

Gerar credencial de sandbox

curl --request POST \     --url https://pix.sandbox.payzu.dev/v1/refund/{transactionId} \     --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