> For the complete documentation index, see [llms.txt](https://passimpay.gitbook.io/passimpay-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://passimpay.gitbook.io/passimpay-api/withdraw.md).

# Withdraw

<mark style="color:red;">**Request limit: once per second. Otherwise, the account will be blocked**</mark>

<mark style="color:green;">`POST`</mark> `https://api.passimpay.io/v2/withdraw`

To enable withdrawals, add the IP address of the server that will be making the requests in the platform settings.

#### **Headers**

<table><thead><tr><th width="221">Name</th><th width="150">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>x-signature</code></td><td>string</td><td>SHA-256 encrypted signature</td></tr><tr><td><code>Content-Type</code></td><td>string</td><td>application/json</td></tr></tbody></table>

#### **Request Body**

<table><thead><tr><th width="190">Name</th><th width="124">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>platformId</code></td><td>integer</td><td>Platform Id</td></tr><tr><td><code>paymentId</code></td><td>integer</td><td>Currency ID. You can get the list of currency IDs <a href="/pages/cCYjpNNmRMVGOnH1c3fk">here</a>.</td></tr><tr><td><code>addressTo</code></td><td>string</td><td>Specify the recipient's wallet address. For <strong>Ripple (XRP)</strong> and <strong>TON</strong>, if it's necessary to add a tag or comment, use the following format:<br><strong><code>address:destinationTag</code></strong></td></tr><tr><td><code>amount</code></td><td>string</td><td>The transaction amount. </td></tr><tr><td><code>symbol</code></td><td>string</td><td>The currency for the <code>amount</code> field corresponds to the ISO 4217 standard. It should have 3 upper case characters. This field is optional; if it is not specified, the default currency is the crypto currency</td></tr><tr><td><code>orderId</code></td><td>string</td><td>A unique identifier for each withdrawal on your resource. Enter a string with a maximum length of 64 and valid characters 'A-Za-z0-9+/=-:.,_'</td></tr></tbody></table>

#### **Successful response (200)**

<table><thead><tr><th width="200">Name</th><th width="131">Type</th><th>Description</th></tr></thead><tbody><tr><td>result</td><td>integer</td><td>Request result: <br><code>1</code>: success </td></tr><tr><td>paymentId</td><td>integer</td><td>Payment ID</td></tr><tr><td>addressTo</td><td>string</td><td>Recipient's Wallet Address</td></tr><tr><td>amount</td><td>string</td><td>Amount in cryptocurrency</td></tr><tr><td>transactionId</td><td>string</td><td>The transaction ID in the Passimpay system. You can use this ID to check the status of the transaction with the <a href="/pages/sndhswmOWC7gQ4aeYiRx"><code>withdrawstatus</code></a> method.</td></tr></tbody></table>

#### **Error Response (400)**

<table><thead><tr><th width="154">Name</th><th width="176">Type</th><th>Description</th></tr></thead><tbody><tr><td>result</td><td>integer</td><td>Request result: <br><code>0</code>: error</td></tr><tr><td>message</td><td>string</td><td>Error description</td></tr></tbody></table>