PayZuDocs

Consultar saque

Veja o status e os detalhes atuais de um saque buscando pelo id, pela sua própria referência ou pelo end-to-end do Pix. Se passar mais de um, todos valem como filtro ao mesmo tempo, então prefira um só quando não tiver certeza de que apontam pra mesma transação.

Autorização

BearerAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de query

id?string

ID da transação.

clientReference?string

Referência externa informada na criação do saque.

endToEndId?string

ID end-to-end do Pix.

virtualAccount?string

Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa.

Tamanholength <= 50

Corpo da resposta

application/json

application/json

application/json

application/json

curl --request GET \  --url 'https://api.payzu.processamento.com/v1/withdraw' \  --header 'Authorization: Bearer $PAYZU_TOKEN'
{
"id": "PAYZU2025081721512946OOLK75",
"status": "PENDING",
"amount": 2,
"type": "WITHDRAW",
"qrCodeText": null,
"qrCodeBase64": null,
"qrCodeUrl": null,
"generatedName": null,
"generatedDocument": null,
"generatedEmail": null,
"payerName": null,
"payerDocument": null,
"payerInstitutionIspb": null,
"payerInstitutionName": null,
"payerAccountNumber": "513579",
"serviceFeeCharged": 1,
"withdrawPixKey": "teste@teste.com",
"withdrawPixType": "email",
"receiverName": null,
"receiverDocument": null,
"receiverInstitutionIspb": null,
"receiverInstitutionName": null,
"receiverAccountNumber": null,
"endToEndId": null,
"createdAt": "2025-08-17T21:51:29.748Z",
"updatedAt": "2025-08-17T21:51:29.748Z",
"paidAt": null,
"clientReference": "withdraw_98765",
"refundEndToEndId": null,
"refundAmount": null,
"refundStatus": null,
"refundReason": null,
"refundDescription": null,
"refundedAt": null,
"cancellationReason": null
}