---
url: https://docs.youcan.shop/youcan-pay/withdrawals/object.md
---
# The Withdrawal Object

**Required scope (OAuth only):** `view-withdrawals`

## Attributes

| Parameter | Type | Description |
| --- | --- | --- |
| `object` | string | Always `v2.withdrawal`. |
| `id` | string | The object's unique identifier. |
| `processor` | string | One of `bank_account`, `cashplus`, `chari_money`. |
| `status` | string | One of `pending`, `processing`, `completed`, `canceled`, `failed`. |
| `amount` | object|null | The withdrawal amount, as a [money object](/youcan-pay/accounts/me#money-object). |
| `fee` | object|null | The fee charged on the withdrawal, as a money object. |
| `is_paid` | boolean | Whether the withdrawal has been paid out. |
| `rejection_reason` | string|null | Why the withdrawal was rejected. |
| `metadata` | object | Arbitrary metadata attached to the withdrawal. |
| `bank_account_id` | string|null | ID of the destination bank account. |
| `approved_at` | string|null | When the withdrawal was approved. |
| `created_at` | string|null | When the withdrawal was first requested. |

## Includes

Pass `?include=bank_account` to embed the related bank account under a `bank_account` key. Only populated when `processor` is `bank_account` or `chari_money`. Supported on both the details and list endpoints.

### The Bank Account Object

| Parameter | Type | Description |
| --- | --- | --- |
| `object` | string | Always `v2.bank_account`. |
| `id` | string | The object's unique identifier. |
| `number` | string | The bank account's RIB. |
| `name` | string|null | The bank account's label. |
| `default` | boolean | Whether this is the account's default bank account. |
| `created_at` | string|null | Date and time the bank account was added. |

## Request

**Endpoint:** `https://youcanpay.com/api/v2/withdrawals/{withdrawal_id}`
**Method:** `GET`

```bash
$ curl --location -g --request GET 'https://youcanpay.com/api/v2/withdrawals/756e502e-d363-42f1-85f0-0b6b43f4d486' \
  --header 'Accept: application/json' \
  -u 'YOUR_PRIVATE_KEY:'
```

## Response

```json
{
  "object": "v2.withdrawal",
  "id": "756e502e-d363-42f1-85f0-0b6b43f4d486",
  "processor": "cashplus",
  "status": "pending",
  "amount": {
    "amount": "500.00",
    "currency": "MAD",
    "localized": "MAD 500.00"
  },
  "fee": {
    "amount": "10.00",
    "currency": "MAD",
    "localized": "MAD 10.00"
  },
  "is_paid": false,
  "rejection_reason": null,
  "metadata": [],
  "bank_account_id": null,
  "approved_at": null,
  "created_at": "2024-01-31 15:11:50"
}
```