PayZu Conta HubSaques

Listar os saques e pagamentos

GET/transactions/withdraw

Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/look-up-a-withdrawal


Query Params

limitintegerPadrão: 20
Itens por página.
cursorstring
nextCursor da página anterior.
statusstring enum
Status do saque.PROCESSINGCONFIRMEDFAILED
dateFromstring
Início do período, pela data de criação.
dateTostring
Fim do período, pela data de criação.
endToEndIdstring
ID end-to-end do Pix.

Headers

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

Responses

200Lista de saques
dataarray of objectsSaques e pagamentos, do mais recente ao mais antigo.
Campos de cada item 11
idstringID do saque.
statusstringStatus do saque.
PROCESSINGCONFIRMEDFAILED
operationstringSaque para chave ou pagamento de QR Code.
WITHDRAWEXTERNAL_PAYMENT
amountintegerValor que chega ao destino, em centavos.
serviceFeeintegerTarifa em centavos, somada ao valor.
totalDebitedintegerTotal que sai da conta, com a tarifa, em centavos.
destinationobjectDestino do saque.
Campos do objeto 3
pixKeystringChave de destino; CPF, e-mail e telefone vêm mascarados.
pixKeyTypestring | nullTipo da chave, deduzido do formato.
EVPCNPJCPFEMAILPHONE
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.
createdAtstringData e hora do registro.
confirmedAtstring | nullData e hora da chegada ao destino.
nextCursorstringCursor da próxima página, ausente na última.
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.

Linguagem

Credenciais Bearer

Token de API

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