Withdraw

This section "Withdrawal" in the API describes the process of performing withdrawal transactions. This API allows users to withdraw their funds from the RPAY.IO platform to external wallets.

To create a withdrawal of funds using RPAY.IO's API, follow these steps:

Step 1:

First, ensure you have the necessary API key for authorization. [link to documentation]

Step2 Initiate withdrawal request:

Use the appropriate API endpoint to create a withdrawal request. You'll need to specify details such as the amount to withdraw and the destination wallet address.

POST https://admin.rpay.io/api/withdraws/

Request Body

Name	Type	Description
sum*	Float	withdrawal amount
to*	String	recipient's wallet
currency*	String	currency (BTC,ETH,LTC, USDT)
chain*	String	Chain (ERC20, TRC20, BTC)
callback	String	url where the callback will arrive

Example:

{
  "sum":0.2202,
  "to": "Ldy9nNN5uqU7FN55Jw3bnWnBUtMDpdF6tY",
  "callback": "https://webhook.site/withdraw",
  "currency": "LTC",
  "chain": "LTC"
}

After submitting the request, the API will return you information about the created output request

{
    "owner_id": "6542593c5b8b1149c008a471",
    "to": "Ldy9nNN5uqU7FN55Jw3bnWnBUtMDpdF6tY",
    "sum": 0.2202,
    "created": "2023-12-29T07:28:16.173000",
    "callback": "https://webhook.site/withdraw",
    "currency": "LTC",
    "chain": "LTC",
    "fee": 0.001,
    "network_fee": 0.0,
    "status": "created",
    "id": "658e751021c35ecf675cf3b7"
}

The https://api.rpay.io/withdraws method in the RPAY.IO API is used to retrieve all withdrawal requests made via the API. This method is particularly useful for users or administrators who need to track and manage multiple withdrawal requests. By invoking this method, one can obtain a comprehensive list of all withdrawals, including their statuses, amounts, and other relevant details, providing a clear overview of all outgoing transactions made from the platform.

GET https://admin.rpay.io/api/withdraws

Request Body

Name	Type	Description
skip	Integer
limit	Integer

The https://api.rpay.io/withdraws/{entity_id} method in RPAY.IO's API is designed for interacting with a specific withdrawal request, identified by {entity_id}. By replacing {entity_id} with the actual ID of a withdrawal transaction, this endpoint allows you to access detailed information about that particular withdrawal, or perform actions such as updating or deleting it.

GET https://admin.rpay.io/api/withdraws/{entity_id}

Request Body

Name	Type	Description
entity_id*	String

DELETE https://admin.rpay.io/api/withdraws/{entity_id}

Request Body

Name	Type	Description
entity_id*	String

//Request example
{
  "sum":0.2202,
  "to": "Ldy9nNN5uqU7FN55Jw3bnWnBUtMDpdF6tY",
  "callback": "https://webhook.site/withdraw",
  "currency": "LTC",
  "chain": "LTC"
}
// Response example
{
    "owner_id": "6542593c5b8b1149c008a471",
    "to": "Ldy9nNN5uqU7FN55Jw3bnWnBUtMDpdF6tY",
    "sum": 0.2202,
    "created": "2023-12-29T07:28:16.173000",
    "callback": "https://webhook.site/withdraw",
    "currency": "LTC",
    "chain": "LTC",
    "fee": 0.001,
    "network_fee": 0.0,
    "status": "created",
    "id": "658e751021c35ecf675cf3b7"
}

To create a withdrawal using API Key, you need to use this endpoint

https://admin.rpay.io/api/withdraws/apikey?api_key=api_key

Where ?api_key=api_key Your key obtained via account.rpay.io or via API.

With the statuses of withdrawals, you can familiarize yourself with the following link Withdrawals