Skip to main content
GET
/
v1
/
withdrawals
/
{withdrawalId}
Get a withdrawal
curl --request GET \
  --url https://api.yuvexpay.com/v1/withdrawals/{withdrawalId} \
  --header 'Authorization: Bearer <token>'
{
  "withdrawal": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "txId": "<string>",
    "grossAmount": 123,
    "feeAmount": 123,
    "netAmount": 123,
    "pixKey": "<string>",
    "pixKeyType": "<string>",
    "isSandbox": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "processedAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

YuvexPay API key. Include as Authorization: Bearer ypk_<env>_<kid>_<secret> where <env> is test (sandbox) or live (production). Create and manage keys in the dashboard under Settings > API Keys.

Path Parameters

​
withdrawalId
string<uuid>
required

The withdrawal ID.

Response

Withdrawal found.

​
withdrawal
object