PayZu PixPix Pagamento
Enviar um Pix para uma chave
POST/withdraw
Confira o passo a passo → https://docs.payzu.com.br/docs/pix/send-to-a-key
Requisições recentes
Body Params
amountnumberobrigatório
Valor do Pix.
pixKeystringobrigatório
Chave Pix de destino.
pixTypestring enumobrigatório
Tipo da chave Pix.
cpfcnpjphoneemailevpcallbackUrlstring
URL que recebe os avisos da transação.
clientReferencestring
Seu identificador. Se repetir, retorna o saque já criado.
descriptionstring
Descrição do saque.
virtualAccountstring
Subconta para separar lojas ou filiais.
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Saque criado
idstringIdentificador da transação na PayZu.
statusstringStatus da transação.
PENDINGCOMPLETEDCANCELEDWAITING_FOR_REFUNDREFUNDEDEXPIREDERRORamountnumberValor em reais, antes da tarifa.
typestringTipo da transação.
DEPOSITWITHDRAWCOMMISSIONLIQUIDATIONADJUSTMENTqrCodeTextstring | 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).
cpfcnpjemailphoneevpreceiverNamestring | 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.
PENDINGCOMPLETEDCANCELEDrefundReasonstring | nullMotivo: seu pedido, MED, depósito de CNPJ recusado ou ação da PayZu.
CUSTOMER_REQUESTINFRACTIONDENY_COMPANY_DEPOSITADMIN_REQUESTrefundDescriptionstring | 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_SLIPTED400Requisiçã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.
409Saque duplicado
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.
422Saque recusado
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.
retryAfterSecondsintegerSegundos de espera antes de tentar de novo.
Esta página ajudou?