PayZuDocs

Get Pix payment

View as Markdown
PortuguêsEnglish中文

Returns the current data of a Pix payment by id, clientReference or endToEndId.

Confira nosso tutorial
GEThttps://api.payzu.processamento.com/v1/withdraw
GET
/withdraw

Query Params

Transaction ID.

External reference provided when creating the withdrawal.

Pix end-to-end ID.

Virtual sub-account (up to 50 characters) used at creation. Accepted as an alternative lookup key.

Responses

curl -X GET "https://api.payzu.processamento.com/v1/withdraw" \  -H "Authorization: Bearer {{token}}"
{
"id": "PAYZU20260817B3PL8SG5WQ000000",
"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": "000000",
"serviceFeeCharged": 1,
"withdrawPixKey": "teste@teste.com",
"withdrawPixType": "email",
"receiverName": null,
"receiverDocument": null,
"receiverInstitutionIspb": null,
"receiverInstitutionName": null,
"receiverAccountNumber": null,
"endToEndId": null,
"createdAt": "2026-08-11T21:51:29.748Z",
"updatedAt": "2026-08-11T21:51:29.748Z",
"paidAt": null,
"clientReference": "withdraw_98765",
"refundEndToEndId": null,
"refundAmount": null,
"refundStatus": null,
"refundReason": null,
"refundDescription": null,
"refundedAt": null,
"cancellationReason": null
}