> For the complete documentation index, see [llms.txt](https://docs.pay.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pay.io/api-reference/user-payment-api/create-a-user-withdrawal.md).

# Create a User Withdrawal

## User withdrawal

> This API endpoint allows users to initiate a withdrawal request to transfer funds from user account to an personal wallet address. The withdrawal requires specifying the amount, currency type, destination wallet, and user identification for processing.

```json
{"openapi":"3.0.0","info":{"title":"pay.io payment gateway","version":"1.0"},"servers":[{"url":"https://gateway.stage.pay.io","variables":{}}],"paths":{"/v1/user/withdraw":{"post":{"callbacks":{},"description":"This API endpoint allows users to initiate a withdrawal request to transfer funds from user account to an personal wallet address. The withdrawal requires specifying the amount, currency type, destination wallet, and user identification for processing.","operationId":"HubwalletPaymentGatewayWeb.Controller.Merchant.Default.withdraw","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_Request"}}},"description":"The user attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Withdraw_Response"}}},"description":"User withdrawal"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Validation_Error_Response"}}},"description":"Validation error - missing required fields, invalid UUID format, or invalid user_reference_id format (only alphanumeric, hyphens, and underscores allowed)"}},"summary":"User withdrawal","tags":["user"]}}},"components":{"schemas":{"Withdraw_Request":{"description":"Request to withdraw funds","properties":{"amount":{"description":"Amount to withdraw, we support high precision due to certain tokens","format":"decimal","type":"string"},"currency_id":{"description":"Currency ID, which can be retrieved using supported currencies.","type":"string"},"user_reference_id":{"description":"The unique user reference to identify a user for transaction tracking","type":"string"},"wallet_address":{"description":"Destination wallet address for withdrawal","type":"string"}},"required":["amount","currency_id","wallet_address","user_reference_id"],"title":"Withdraw_Request","type":"object"},"Withdraw_Response":{"description":"Response for withdraw request","properties":{"amount":{"description":"Withdrawal amount","type":"string"},"currency":{"description":"Currency name","type":"string"},"requires_approval":{"description":"Whether transaction requires approval","type":"boolean"},"status":{"description":"Transaction status. `processing` — submitted to provider; `pending_approval` — awaiting manual approval.","enum":["processing","pending_approval"],"type":"string"},"transaction_uuid":{"description":"Transaction identifier for tracking","format":"uuid","type":"string"},"wallet_address":{"description":"Destination wallet address","type":"string"}},"required":["transaction_uuid","currency","wallet_address","status","amount"],"title":"Withdraw_Response","type":"object"},"Validation_Error_Response":{"description":"Validation error response format","properties":{"error":{"description":"Error message","type":"string"},"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"description":"Field-specific validation errors","type":"object"}},"required":["error","errors"],"title":"Validation_Error_Response","type":"object"}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.pay.io/api-reference/user-payment-api/create-a-user-withdrawal.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.