Riversweeps
Create, deposit, withdraw, close and check balance on player accounts using query-string URLs.
- Base URL
http://river-pay.com/api- Authentication
- Login + password, IP allowlist
- Sections
- 8
Overview#
RiverPay exposes five account operations. Every request is a URL with its parameters in the query string.
| Item | Value |
|---|---|
| Base URL | http://river-pay.com/api |
| HTTP method | Not specified in source (all parameters are passed in the query string) |
| Response format | JSON |
| Access | Your server IP must be added to the list of allowed IPs |
Operations
| Operation | Path |
|---|---|
| Create account | /create |
| Deposit | /deposit |
| Withdraw | /withdrawal |
| Close account | /close |
| Get balance | /balance |
Response status
Every response has a STATUS field. 0 is returned in all success examples and 1 in the error example. See Error responses.
Authentication#
To get access to the API, your IP must be added to the list of allowed IPs.
Every request includes your account credentials as query parameters:
| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your RiverPay login. Not otherwise specified in source. |
password |
Yes | Your RiverPay password. Not otherwise specified in source. |
http://river-pay.com/api/balance?login={LOGIN}&password={PASSWORD}&code={CODE}How to obtain credentials: Not specified in source.
Create account#
http://river-pay.com/api/create
Creates a new account and returns its code.
Request
http://river-pay.com/api/create?login={LOGIN}&password={PASSWORD}&amount={AMOUNT}&bounceback={1|0}| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your login |
password |
Yes | Your password |
amount |
Yes | Not specified in source |
bounceback |
Not listed as mandatory | 1 or 0. Meaning not specified in source. |
Response example
{"STATUS":0,"data":{"code":"00-00-00-00-00-01"}}Deposit#
http://river-pay.com/api/deposit
Deposits an amount to an existing account.
Request
http://river-pay.com/api/deposit?login={LOGIN}&password={PASSWORD}&code={CODE}&amount={AMOUNT}&bounceback={1|0}| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your login |
password |
Yes | Your password |
code |
Yes | Account code, as returned by Create account |
amount |
Yes | Not specified in source |
bounceback |
Not listed as mandatory | 1 or 0. Meaning not specified in source. |
Response example
{"STATUS":0,"data":{"code":"00-00-00-00-00-01","balance":"10.00"}}Withdraw#
http://river-pay.com/api/withdrawal
Withdraws an amount from an account.
Request
http://river-pay.com/api/withdrawal?login={LOGIN}&password={PASSWORD}&code={CODE}&amount={AMOUNT}| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your login |
password |
Yes | Your password |
code |
Yes | Account code |
amount |
Yes | Not specified in source |
Response example
{"STATUS":0,"data":{"code":"00-00-00-00-00-01","balance":"5.00"}}Close account#
http://river-pay.com/api/close
Closes an account.
Request
http://river-pay.com/api/close?login={LOGIN}&password={PASSWORD}&code={CODE}| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your login |
password |
Yes | Your password |
code |
Yes | Account code |
Response example
{"STATUS":0,"data":{"code":"00-00-00-00-00-01"}}Get balance#
http://river-pay.com/api/balance
Returns the balance of an account.
Request
http://river-pay.com/api/balance?login={LOGIN}&password={PASSWORD}&code={CODE}| Parameter | Required | Description |
|---|---|---|
login |
Yes | Your login |
password |
Yes | Your password |
code |
Yes | Account code |
Response example
{"STATUS":0,"data":{"balance":"100.00"}}Error responses#
Example of an error message for any request:
{"STATUS":1,"data":{"message":"\u0421\u0447\u0435\u0442 00-00-00-00-00-01<\/b> \u0443\u0436\u0435 \u0437\u0430\u043a\u0440\u044b\u0442"}}| Field | Description |
|---|---|
STATUS |
1 in the error example |
data.message |
Error message in Unicode Entities |
A list of individual error codes: Not specified in source.