PayZu Conta HubSaques

Enviar um Pix para uma chave

POST/transactions/withdraw

Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/send-to-a-key


Body Params

amountintegerobrigatório
Valor que chega ao destino, em centavos.
pixKeystringobrigatório
Chave Pix de destino.
pixKeyTypestring enum
Tipo da chave Pix.EVPCNPJCPFEMAILPHONE
commentstring
Texto enviado ao destinatário.
callbackUrlstring
URL que recebe os avisos da transação.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
Idempotency-Keystring
Chave única da operação, para repetir sem duplicar.
acceptstring
Formato da resposta.

Responses

201Saque criado
idstringID do saque.
statusstringStatus do saque.
PROCESSINGCONFIRMEDFAILED
amountintegerValor que chega ao destino, em centavos.
serviceFeeintegerTarifa em centavos, somada ao valor.
totalDebitedintegerTotal que sai da conta, com a tarifa, em centavos.
pixKeystringChave de destino do saque, normalizada.
bankobject | nullInstituição de destino do Pix.
Campos do objeto 2
namestring | nullNome da instituição.
ispbstring | nullISPB da instituição de destino.
commentstring | nullTexto enviado ao destinatário.
endToEndIdstring | nullID end-to-end do Pix.
failureReasonstring | nullMotivo da recusa do banco, para exibir.
callbackUrlstring | nullURL que recebe os avisos da transação.
createdAtstringData e hora do registro.
confirmedAtstring | nullData e hora da chegada ao destino.
400Requisição inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
409Idempotency-Key já usada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
412Pré-requisito pendente
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
422Saque recusado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
429Limite de requisições atingido
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
502Falha na instituição financeira
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
detailsobjectContexto do erro, como valores e limites.
503Serviço indisponível
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.

Linguagem

Credenciais Bearer

Token de API

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