---
title: "Get a withdrawal"
method: GET
path: "/v1/withdrawals/{withdrawalId}"
tags: ["Withdrawals"]
---

# Get a withdrawal

`GET /v1/withdrawals/{withdrawalId}`

## Request

- Base URL: `https://api.yuvexpay.com`
- URL: `https://api.yuvexpay.com/v1/withdrawals/{withdrawalId}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/yuvexpay/apis/yuvexpay-api/docs/v1/withdrawals/:withdrawalId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a single withdrawal by its ID.

## Path parameters

- `withdrawalId` string, uuid, required

## Response `200`

Withdrawal found.

- object
  - `withdrawal` Withdrawal: The withdrawal as returned by `GET /v1/withdrawals/{withdrawalId}`.
    - `id` string, uuid
    - `txId` string: Transaction identifier: `WIT` followed by a millisecond timestamp and 5 uppercase alphanumerics, e.g. `WIT1746280868443K3F9Q`. Treat it as an opaque string.
    - `grossAmount` number
    - `feeAmount` number
    - `netAmount` number
    - `pixKey` string: The destination PIX key, masked. The full key is never returned by the API once the withdrawal is created.
    - `pixKeyType` string: Type of PIX key: `CPF`, `CNPJ`, `EMAIL`, `PHONE` or `EVP` (random key).
    - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CANCELLED': Possible withdrawal statuses.
    - `isSandbox` boolean
    - `createdAt` string, date-time
    - `paymentMethod` 'PIX'
    - `currency` 'BRL'
    - `processedAt` string, date-time, nullable
    - `errorMessage` string, nullable: Generic message from the same fixed set as the `WITHDRAWAL_FAILED` webhook `failureReason`, or `Saque em processamento.` while the withdrawal is `PENDING` or `PROCESSING`. `null` when no reason was recorded or the withdrawal is `COMPLETED`.
    - `providerErrorCode` string, nullable: Rejection code reported by the receiving institution: `AC03`, `AC06`, `AC07`, `AG03`, `AM18`, `RR04`, `SL02`, `BE01`, `CH11`, `PIX_KEY_NOT_FOUND`, `PIX_KEY_OWNER_MISMATCH`, `ACCOUNT_CLOSED` or `ACCOUNT_BLOCKED`. `null` for every other failure and for withdrawals that did not fail.

## Other responses

- `401`: Missing or invalid authentication token.
- `404`: Resource not found.

## Changes

- **2026-10-02** `e1a5e956b369`: 1 info
  - added the optional property `withdrawal/providerErrorCode` to the response with the `200` status
- **2026-04-14** `74ad5da44cf9`: 4 info
  - added the optional property `withdrawal/currency` to the response with the `200` status
  - added the optional property `withdrawal/errorMessage` to the response with the `200` status
  - added the optional property `withdrawal/paymentMethod` to the response with the `200` status
  - added the optional property `withdrawal/processedAt` to the response with the `200` status
- **2026-04-14** `c75657100757`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/changes/v1/withdrawals/:withdrawalId/get.md)

---

[API](https://skmtc.dev/yuvexpay/apis/yuvexpay-api.md) - [All operations](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/revisions/d0e6ad21d782?raw)