SaqSaq Docs
API 端点Saques

查询提现

GET
/withdraw

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

id?string

Transaction ID.

clientReference?string

External reference provided when creating the withdrawal.

endToEndId?string

Pix end-to-end ID.

virtualAccount?string

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

Lengthlength <= 50

Header Parameters

Content-Type*string

Obrigatório em toda chamada Saq.

Default"application/json"
Value in"application/json"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.saq.processamento.com/v1/withdraw?id=SAQ2025081721512946OOLK75" \  -H "Content-Type: application/json"

{
  "id": "SAQ2025081721512946OOLK75",
  "status": "PENDING",
  "amount": 2,
  "type": "WITHDRAW",
  "callbackUrl": "https://webhook.cool/",
  "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
}

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "querystring/dateFrom Invalid input: expected string, received undefined",
  "requestId": "cmou00000abcdef01s6ghij1k2lm"
}
{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Missing or invalid Bearer token",
  "requestId": "cmou00000abcdef01s6ghij1k2lm"
}
{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Resource not found",
  "requestId": "cmou00000abcdef01s6ghij1k2lm"
}

Create Withdrawal (Pix key)

Send a Pix **cash out** to the specified Pix key.

Create Withdrawal using QR Code

Cash out using a **Pix QR Code** (static/dynamic). If `amount` is not provided, the QR Code's embedded value will be used. No momento a Saq só suporta QR Code dinâmico. QR estático ainda não é processado.