Deposit

To create a deposit through RPAY.IO's API, follow these steps:

Step 1:

Obtain an API key for API access. [link to documentation]

Step 2:

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

Request Body

Name	Type	Description
sum*	Integer	Amount to deposit
currency*	String	Currency type
chain*	String	Blockchain chain
callback	String	Callback URL
minutes_to_expired	Integer	Time in minutes after which deposit expires and status expired is sent via callback

200: OK

400: Bad Request

401: Unauthorized

403: Forbidden

500: Internal Server Error

Use the POST method https://api.rpay.io/deposits, specifying the amount, currency, chain, and callback URL. For example, to create a deposit in USDT on the TRX chain:

{
  "sum": 10,
  "currency": "USDT",
  "chain": "TRX",
  "callback": "https://webhook.site/3ad58e66-7c72-446c-b187-42f227978d14",
  "minutes_to_expired": 60
}

It is also worth noting that you can create a deposit without a fixed amount. In this case, you will be sent information about the actual deposit in the "paid" field in Callback

The API will return details of the created deposit, including its status and unique identifier.

Example:

{
    "owner_id": "6542593c5b8b1149c008a471",
    "wallet": "TFkEnYa8WLY9mDSNSg5ygaqyMjGVFg4y1W",
    "type": "OKX",
    "status": "created",
    "exchange": {},
    "callback": "https://webhook.site/3ad58e66-7c72-446c-b187-42f227978d14",
    "callback_response": "",
    "sum": 10.0,
    "currency": "USDT",
    "chain": "TRX",
    "paid": "0",
    "fee": "0.55",
    "created": "2023-12-27T10:04:39.303000",
    "id": "658bf6b72ca2922114e7884e"
}

You can use the GET method to obtain details about a specific deposit.

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

Request Body

Name	Type	Description
skip	Integer
limit	Integer

If necessary, delete a deposit using the DELETE method.

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

Request Body

Name	Type	Description
entity_id*	String

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

Request Body

Name	Type	Description
entity_id*	String

The https://api.rpay.io/deposits/{entity_id} endpoint in the RPAY.IO API is for managing specific deposits. By substituting the actual deposit ID in place of {entity_id}, you can retrieve, update or delete the information associated with that specific deposit. It is typically used in scenarios where you need to interact or modify details of an existing deposit in the system

Request example
{
  "sum": 10,
  "currency": "USDT",
  "chain": "TRX",
  "callback": "https://webhook.site/3ad58e66-7c72-446c-b187-42f227978d14"
}
Response example
{
    "owner_id": "6542593c5b8b1149c008a471",
    "wallet": "TFkEnYa8WLY9mDSNSg5ygaqyMjGVFg4y1W",
    "type": "OKX",
    "status": "created",
    "exchange": {},
    "callback": "https://webhook.site/3ad58e66-7c72-446c-b187-42f227978d14",
    "callback_response": "",
    "sum": 10.0,
    "currency": "USDT",
    "chain": "TRX",
    "paid": "0",
    "fee": "0.55",
    "created": "2023-12-27T10:04:39.303000",
    "id": "658bf6b72ca2922114e7884e"
}

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

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

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

With the statuses of deposits, you can familiarize yourself with the following link Deposit