# 12. Withdrawal (Alias)

## Deposit with Wallet 'Alias' Information

<mark style="color:yellow;">`POST`</mark> `{{WalletUrl}}/api/v1/wallet/withdraw/by/alias`&#x20;

{% hint style="info" %}
**Note:** To use this service, it is mandatory to include the **apikeypublic** and **apiclientpublic** parameters in the Header field.

\
[<mark style="color:green;">**WalletAPI Address**</mark>](/payment-orchestration-integration-document/environment.md)
{% endhint %}

**The parameters that need to be sent to the service are as follows:**

<table><thead><tr><th width="162">Parameter</th><th width="95.80859375">Type</th><th width="135.96875">Compulsory</th><th width="403">Description</th></tr></thead><tbody><tr><td>apikeypublic</td><td>string</td><td>Yes</td><td>It is the general key information used to verify API access.</td></tr><tr><td>apiclientpublic</td><td>string</td><td>Yes</td><td>It is the key information that identifies the client and provides authentication during the service call.</td></tr></tbody></table>

{% tabs %}
{% tab title="Service Reguest - JSON" %}

```json
{
  "Alias": "2816220769",
  "Amount": 0.1,
  "Description": "{{$randomJobDescriptor}}",
  "ExternalReference": "{{$guid}}"
}
```

{% endtab %}
{% endtabs %}

## Service Request

| Parameter         | Type    | Description                                                                             |
| ----------------- | ------- | --------------------------------------------------------------------------------------- |
| Amount            | decimal | The amount to be withdrawn.                                                             |
| Description       | string  | The description of the relevant transaction.                                            |
| Alias             | string  | The account number assigned to the Wallet (1234567890).                                 |
| ExternalReference | string  | The transaction tracking number. You can use this information to track the transaction. |

{% tabs %}
{% tab title="Service Reguest - JSON" %}
{% code lineNumbers="true" %}

```json
{
    "IsSuccess": true,
    "IsFailure": false,
    "Value": {
        "Id": "86d1ed9e-9e61-4c8e-96db-4f06030ea19d",
        "Alias": "2816220769",
        "WalletId": "7883fb19-2359-4a9b-b917-f08a259898ed",
        "TransactionType": "Withdrawal",
        "Amount": 0.1,
        "GiftAmount": null,
        "Description": "Regional",
        "ExternalReference": "0f84e841-847f-426a-b02f-20cc93e2d667",
        "CreatedAt": "2025-08-20T10:13:13.9375891Z",
        "UpdatedAt": null,
        "BalanceAfterTransaction": 2.90,
        "GiftBalanceId": null,
        "UniqueCode": "23fea619-eaae-4a5a-8740-458d989edd47",
        "CashbackAmount": 0
    }
}
```

{% endcode %}
{% endtab %}
{% endtabs %}

## Service Response

<table><thead><tr><th width="192">Parameter</th><th width="147.89192708333331">Type</th><th>Description</th></tr></thead><tbody><tr><td>IsFailure</td><td>bool</td><td>Indicates whether an error occurred during the transaction.</td></tr><tr><td>IsSuccess</td><td>bool</td><td>Indicates that the service has been successfully completed.</td></tr><tr><td>Errors</td><td>Array</td><td>A list containing the error details encountered during the transaction.</td></tr><tr><td>Value</td><td>Array&#x3C;Items></td><td>Contains the main data set returned from the service.</td></tr></tbody></table>

## Service Response (Value)

<table><thead><tr><th width="234.05859375">Parameter</th><th width="162.38671875">Type</th><th width="348.94140625">Description</th></tr></thead><tbody><tr><td>Id</td><td>Guid</td><td>It is the unique identifier generated by the system for the record.</td></tr><tr><td>WalletOwnerId</td><td>Guid</td><td>It is the unique identifier of the relevant wallet owner.</td></tr><tr><td>Name</td><td>string</td><td>It is the name information of the wallet owner.</td></tr><tr><td>Alias</td><td>string</td><td>It is the alias information representing the wallet.</td></tr><tr><td>RegionId</td><td>string</td><td>It is the code of the region where the wallet owner is located.</td></tr><tr><td>CurrencyCode</td><td>string</td><td>It is the currency code used by the wallet for transactions.</td></tr><tr><td>Balance</td><td>decimal</td><td>It is the total balance amount in the wallet.</td></tr><tr><td>AvailableBalance</td><td>decimal</td><td>It is the available, spendable balance information.</td></tr><tr><td>TotalGiftBalance</td><td>decimal</td><td>It shows the total gift balance amount in the wallet.</td></tr><tr><td>BlockedBalance</td><td>decimal</td><td>It is the blocked, unusable balance amount.</td></tr><tr><td>FrozenUntil</td><td>DateTime</td><td>It is the end date until which the wallet will remain frozen.</td></tr><tr><td>IsFrozen</td><td>bool</td><td>It indicates whether the wallet is frozen or not.</td></tr><tr><td>IsDeleted</td><td>bool</td><td>It indicates whether the record has been deleted.</td></tr><tr><td>CreatedAt</td><td>DateTime</td><td>It is the timestamp of record creation.</td></tr><tr><td>UpdatedAt</td><td>DateTime</td><td>It is the timestamp of the last update made on the record.</td></tr><tr><td>TransactionId</td><td>Guid</td><td>It is the unique identifier number of the transaction.</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developer.paywall.one/payment-orchestration-integration-document/wallet-services/2.-wallet/12.-withdrawal-alias.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.