MoneyPipe Merchant API v1
- Payment page
- Error Codes
- API Endpoints
- BASICS
- Ping
- Operation show
- Operations list
- Create operation
- Cancel operation
- Transactions list
- Transaction show
- Link transactions
- Reject transactions
- Rates
- Withdrawal
- Voucher list
- Voucher show
- Create voucher
- Cancel voucher
- Pay off voucher
- Create Exchange
- Exchange Rates
- Create Cross Exchange
- Show Cross Exchange
- Cancel Cross Exchange
Payment page
Redirect statuses
Status code
|
Description |
1 |
Invoice canceled |
2 |
Invoice not found |
3 |
Application not found |
4 |
Invoice expired |
5 |
Invoice already handled |
6 |
Payment gateways not available |
7 |
Company banned |
8 |
Failed payment gateway |
Error Codes
Error Codes
Error code |
Http Status |
Message |
0 | 400 |
Something went wrong |
1 | 410 |
Deprecated action |
2 | 401 |
Unauthenticated |
3 | 403 |
Application banned |
4 | 403 |
Company banned |
5 | 404 |
Operation not found |
6 | 404 |
Transaction not found |
7 | 400 |
Operation not created |
8 | 400 |
Cancel not allowed |
9 | 422 |
Validation errors |
10 | 415 |
Unsupported Content Type |
11 | 400 |
Withdrawal is not allowed |
12 | 400 |
Withdrawal limit |
13 | 400 |
Not found available wallets for withdrawal |
14 | 404 |
Voucher Not Found |
15 | 400 |
Voucher not created |
16 | 400 |
Cancel not allowed |
17 | 400 |
Unable to pay off voucher |
18 | 404 |
Cross Exchange Not Found |
19 | 400 |
Cross Exchange not created |
20 | 400 |
Cancel of cross exchange not allowed |
21 | 400 |
Exchange pair not available |
22 | 400 |
Exceeded the number of exchange operations |
23 | 400 |
Currency exchange has been limited |
24 | 400 |
Available wallet for exchange was not found |
25 | 400 |
Exchange not created |
API Endpoints
BASICS
- All URL's on this Documentation are for the Sandbox.
- Production url don't have prefix "sandbox". (Example: https://api.moneypipe.com/v1/rates)
- POST or PUT requests should have Content-Type "application/json"
- "Authorization: Bearer {token}" header is used for authentication.
Operation statuses:
Status
|
Name |
0 |
New |
1 |
Successful |
2 |
Failed |
3 |
Expired |
4 |
Canceled |
5 |
Processed |
Transaction statuses:
Status | Name |
1 |
Confirmed |
2 |
Undefined |
4 |
Rejected |
Vouchers statuses:
Status | Name |
0 |
New |
1 |
Successful |
2 |
Cancelled |
3 |
Expired |
Ping
Request:
GET https://api.moneypipe.com/sandbox/v1/ping
Request headers:
Name | Value |
Authorization |
Bearer {token} |
Response:
200
Operation show
Request:
GET https://api.moneypipe.com/sandbox/v1/operations/{operation_id}
Request headers:
Response:
200
{ "data": { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": "c84b5aae7378b62d0e47", "application_name": "Application name", "category": "application", "order_id": "422", "amount": "85.30000000", "fee": "0.00000000", "amount_paid": "0.01563549", "rate": "0.00018330", "currency": "USD", "currency_paid": "BTC", "status": "confirmed", "address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [ { "id": "fJoJzw8FdOruNQnbLRvL", "tx_id": "miIq7CTGx3PPryqOaOf1KN7nBDOYMf6tiNRl8avIXBbEqDWDhfgbomzJHZpF", "amount": "0.01563549", "status": "confirmed", "linked": true, "reject_reason": null, "created_at": "2019-10-27T13:33:03.224501Z", "updated_at": "2019-10-27T13:33:03.224562Z" } ] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string |
Operation id |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation Category (application, manual) |
order_id | string |
Sales Order Number |
amount | string |
Operation amount |
fee | string |
Fee of the operation amount |
amount_paid | string |
Paid Operation Amount |
rate | string |
Exchange Rate at the moment of payment |
currency | string |
Currency in which the operation was issued |
currency_paid | string |
Currency in which the operation will be paid |
status | string |
Operation Status |
address | string |
Operation Address |
created_at | string |
Operation Creation Date |
updated_at | string |
Operation Change Date |
payment_url | string |
Link to the payment page |
redirect_url | string |
Page link, to which there will be a redirect from the payment page |
transactions | array |
Operation Transaction List |
Transaction details:
Parameter | Type | Description |
---|---|---|
id |
string |
Transaction id |
tx_id |
string |
Transaction id in Blockchain |
amount |
string |
Transaction amount |
status |
string |
Transaction status |
linked |
bool |
The transaction was linked manually |
reject_reason |
string |
Reason of rejecting transaction (only with reject status) |
created_at |
string |
Date of transaction was created |
updated_at |
string |
Date of transaction was changed |
Operations list
Request:
GET |
https://api.moneypipe.com/sandbox/v1/operations |
Request headers:
Query parameters:
Parameter | Description | For example |
---|---|---|
sort | Sort by fields: id, category, order_id, amount, fee, amount_paid, rate, currency, currency_paid, created, updated. | sort=created |
sort_type | Sort types: asc, desc. | sort_type=asc |
id | Filter by id. Comma separated values. | id=operationid1,operationId2,operationId3 |
category | Filter by categories: application, manual. | category=application |
order_id | Filter by order_id. Comma separated values. | order_id=orderId1 |
amount_from | Filter from specified amount value. | amount_from=0.001 |
amount_to | Filter to specified amount value. | amount_to=20 |
fee_from | Filter from specified fee value | fee_from=0.001 |
fee_to | Filter to specified fee value | fee_to=20 |
amount_paid_from | Filter from specified amount_paid value | amount_paid_from=0.001 |
amount_paid_to | Filter to specified amount_paid values | amount_paid_to=20 |
currency | Filter by currency. Values are separated by commas. | currency=EUR,btc |
currency_paid | Filter by currency_paid. Values are separated by commas. | currency_paid=EUR,btc |
status | Filter by status. Values are separated by commas | status=0 |
address | Filter by address | address=2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7 |
created_from | Filter the creation date from the specified value | created_from=2019-03-21 |
created_to | Filter the creation date from to specified value | created_to=2019-03-21 |
page | Current page number | page=2 |
per_page | How many lines to display per page | per_page=10 |
Response:
200
{ "data": [ { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": "c84b5aae7378b62d0e47", "application_name": "Application name", "category": "application", "order_id": "422", "amount": "85.30000000", "fee": "0.00000000", "amount_paid": "0.01563549", "rate": "0.00018330", "currency": "USD", "currency_paid": "BTC", "status": "confirmed", "address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [ { "id": "fJoJzw8FdOruNQnbLRvL", "tx_id": "miIq7CTGx3PPryqOaOf1KN7nBDOYMf6tiNRl8avIXBbEqDWDhfgbomzJHZpF", "amount": "0.01563549", "status": "confirmed", "linked": true, "reject_reason": null, "created_at": "2019-10-27T13:33:03.224501Z", "updated_at": "2019-10-27T13:33:03.224562Z" } ] } ], "links": { "first": "https://api.moneypipe.com/sandbox/v1/operations?page=1", "last": "https://api.moneypipe.com/sandbox/v1/operations?page=2", "prev": null, "next": "https://api.moneypipe.com/sandbox/v1/operations?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 2, "path": "https://api.moneypipe.com/sandbox/v1/operations", "per_page": 50, "to": 50, "total": 100 } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string | Operation ID |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (application, manual) |
order_id | string | Clients` order number |
amount | string | Operation amount |
fee | string | Fee from operation amount |
amount_paid | string | Paid amount of operation |
rate | string | Exchange rate at the moment of payment |
currency | string | Currency of issued operation |
currency_paid | string | Currency in which operation will be paid |
status | string | Operation status |
address | string | Operation address |
created_at | string | Date of operation creation |
updated_at | string | Date of operation change |
payment_url | string | Link to the payment page |
redirect_url | string | Link to the page, to which redirect from payment page will be made |
transactions | array | List of operation transactions |
Transaction details:
Parameter | Type | Description |
---|---|---|
id | string | Transaction id |
tx_id | string | Transaction id in Blockchain |
amount | string | Transaction amount |
status | string | Transaction status |
linked | bool | The transaction was linked manually |
reject_reason | string | Reason of rejecting transaction (only with reject status) |
created_at | string | Date of transaction was created |
updated_at | string | Date of transaction was changed |
Create operation
Request:
POST |
https://api.moneypipe.com/sandbox/v1/operations |
Request headers:
Request body:
{ "amount": "17.068", "currency": "USD", "order_id": "1866", "payment_currency": "BTC", "redirect_url": "https://example.net/redirect/payment/moneypipe" }
Body details:
Parameter | Type | Description |
---|---|---|
amount * |
string |
Amount set |
currency * |
string |
Currency of operation |
order_id * |
string |
Sales Order Number |
payment_currency |
string |
In what currency to pay |
redirect_url |
string |
URL to redirect to |
* - required
Response:
201
{ "data": { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": "c84b5aae7378b62d0e47", "application_name": "Application name", "category": "application", "order_id": "422", "amount": "85.30000000", "fee": "0.00000000", "amount_paid": null, "rate": "0.00018330", "currency": "USD", "currency_paid": "BTC", "status": "new", "address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string | Operation ID |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (application, manual) |
order_id | string | Clients` order number |
amount | string | Operation amount |
fee | string | Fee from operation amount |
amount_paid | string | Paid amount of operation |
rate | string | Exchange rate at the moment of payment |
currency | string | Currency of issued operation |
currency_paid | string | Currency in which operation will be paid |
status | string | Operation status |
address | string | Operation address |
created_at | string | Date of operation creation |
updated_at | string | Date of operation change |
payment_url | string | Link to the payment page |
redirect_url | string | Link to the page, to which redirect from payment page will be made |
transactions | array | List of operation transactions |
Cancel operation
Request:
PUT |
https://api.moneypipe.com/sandbox/v1/operations/{operation_id}/cancel |
Request headers:
Response:
204
Transactions list
Request:
GET |
https://api.moneypipe.com/sandbox/v1/transactions |
Request headers:
Query parameters:
Parameter | Description | For example |
---|---|---|
sort | Sort by fields: id, operation, amount, linked, reject_reason, created_at, updated_at. | sort=created |
sort_type | Sort types: asc, desc. | sort_type=asc |
id | Filter by id. Comma separated values. | id=transactionId1,transactionId2 |
operation_id | Filter by operation. Comma separated values. | operation_id=operationId1,operationId2 |
tx_id | Filter by tx_id from Blockchain. | tx_id=yqOaOf1KN7nBDOYMf6tiNR |
amount_from | Filter from specified amount value. | amount_from=0.001 |
amount_to | Filter to specified amount value. | amount_to=20 |
status | Filter by status. Values are separated by commas | status=0 |
linked | Filter by linked. It have to be 0 or 1 | linked=1 |
reject_reason | Filter by reason | reject_reason=23 |
created_from | Filter the creation date from the specified value | created_from=2019-03-21 |
created_to | Filter the creation date from to specified value | created_to=2019-03-21 |
page | Current page number | page=2 |
per_page | How many lines to display per page | per_page=10 |
Response:
200
{ "data": [ { "id": "LEEPOu4cmIY4IsQhdokf", "tx_id": "9rmE5pF9zTgDqjeYihhtQcS9oknFGbwAy81ZcKYI73cx11TxPwuUZ51xMuIY", "operation_id": "We0lYsfqkDKEn0LMkSbb", "amount": "0.29797886", "status": "confirmed", "linked": false, "reject_reason": null, "created_at": "2019-10-27T16:32:24.993010Z", "updated_at": "2019-10-27T16:32:24.993072Z" } ], "links": { "first": "https://api.moneypipe.com/sandbox/v1/transactions?page=1", "last": "https://api.moneypipe.com/sandbox/v1/transactions?page=2", "prev": null, "next": "https://api.moneypipe.com/sandbox/v1/transactions?page=2" }, "meta": { "current_page": 1, "from": 1, "last_page": 2, "path": "https://api.moneypipe.com/sandbox/v1/transactions", "per_page": 50, "to": 50, "total": 100 } }
Transaction details:
Parameter |
Type |
Description |
id |
string |
Transaction ID |
tx_id |
string |
Transaction ID in Blockchain |
amount |
string |
Transaction amount |
status |
string |
Transaction status |
linked |
bool |
The transaction was linked manually |
reject_reason |
string |
Reason of rejecting transaction (only with reject status) |
created_at |
string |
Date of transaction was created |
updated_at |
string |
Date of transaction was changed |
Transaction show
Request:
GET |
https://api.moneypipe.com/sandbox/v1/transactions/{transaction_id} |
Request headers:
Response:
200
{ "data": { "id": "729612ebf589bf9647f4", "tx_id": "5zlRz0QGP3sBDY4qSXzYWLTrWzEzYHpqDX6Uffzcp2dyRNLMBGvmvtXFV7EL", "operation_id": "OxnLtIYdgdkW9Dse0uSP", "amount": "0.36803330", "status": "rejected", "linked": false, "reject_reason": null, "created_at": "2019-10-27T16:50:20.737025Z", "updated_at": "2019-10-27T16:50:20.737091Z" } }
Transaction details:
Parameter | Type | Description |
---|---|---|
id |
string |
Transaction ID |
tx_id |
string |
Transaction ID in Blockchain |
operation_id |
string |
Operation ID |
amount |
string |
Transaction amount |
status |
string |
Transaction status |
linked |
bool |
The transaction was linked manually |
reject_reason |
string |
Reason of rejecting transaction (only with reject status) |
created_at |
string |
Date of transaction was created |
updated_at |
string |
Date of transaction was changed |
Link transactions
Request:
PUT |
https://api.moneypipe.com/sandbox/v1/operations/{operation_id}/link-transactions |
Request headers:
Request body:
{ "tx_id": ["5ed8a94eedf038930c17", "cf4029434106009bdc31"] }
Body details:
Parameter | Type | Description |
---|---|---|
tx_id * | array | Array of transaction ID`s |
* - required
Response:
200
{ "data": { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": "c84b5aae7378b62d0e47", "application_name": "Application name", "category": "application", "order_id": "422", "amount": "185.30000000", "fee": "0.00000000", "amount_paid": "0.03127098", "rate": "0.00018330", "currency": "USD", "currency_paid": "BTC", "status": "confirmed", "address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [ { "id": "5ed8a94eedf038930c17", "tx_id": "miIq7CTGx3PPryqOaOf1KN7nBDOYMf6tiNRl8avIXBbEqDWDhfgbomzJHZpF", "amount": "0.01563549", "status": "confirmed", "linked": true, "reject_reason": null, "created_at": "2019-10-27T13:33:03.224501Z", "updated_at": "2019-10-27T13:33:03.224562Z" }, { "id": "cf4029434106009bdc31", "tx_id": "544378d028fe9d6a3e3200787c7b3e60e4ef987427d7dc32af87507ffeaccfaa", "amount": "0.01563549", "status": "confirmed", "linked": true, "reject_reason": null, "created_at": "2019-10-27T13:33:03.224501Z", "updated_at": "2019-10-27T13:33:03.224562Z" } ] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string | Operation ID |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (application, manual) |
order_id | string | Clients` order number |
amount | string | Operation amount |
fee | string | Fee from operation amount |
amount_paid | string | Paid amount of operation |
rate | string | Exchange rate at the moment of payment |
currency | string | Currency of issued operation |
currency_paid | string | Currency in which operation will be paid |
status | string | Operation status |
address | string | Operation address |
created_at | string | Date of operation creation |
updated_at | string | Date of operation change |
payment_url | string | Link to the payment page |
redirect_url | string | Link to the page, to which redirect from payment page will be made |
transactions | array | List of operation transactions |
Transaction details:
Parameter | Type | Description |
---|---|---|
id | string | Transaction ID |
tx_id | string |
Transaction ID in Blockchain |
amount | string |
Transaction amount |
status | string | Transaction status |
linked | bool | The transaction was linked manually |
reject_reason | string |
Reason of rejecting transaction (only with reject status) |
created_at | string |
Date of transaction was created |
updated_at | string |
Date of transaction was changed |
Reject transactions
Request:
PUT |
https://api.moneypipe.com/sandbox/v1/operations/{operation_id}/reject-transactions |
Request headers:
Request body:
{ "tx_id": ["5ed8a94eedf038930c17"], "reason": "Wrong payment" }
Body details:
Parameter | Type | Description |
---|---|---|
tx_id * | array | Array of transactions ID`s |
reason * | string | Reasons of reject |
* - required
Response:
200
{ "data": { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": "c84b5aae7378b62d0e47", "application_name": "Application name", "category": "application", "order_id": "422", "amount": "185.30000000", "fee": "0.00000000", "amount_paid": "0.00000000", "rate": "0.00018330", "currency": "USD", "currency_paid": "BTC", "status": "new", "address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [ { "id": "cf4029434106009bdc31", "tx_id": "miIq7CTGx3PPryqOaOf1KN7nBDOYMf6tiNRl8avIXBbEqDWDhfgbomzJHZpF", "amount": "0.01563549", "status": "rejected", "linked": false, "reject_reason": "Wrong payment", "created_at": "2019-10-27T13:33:03.224501Z", "updated_at": "2019-10-27T13:33:03.224562Z" } ] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string | Operation ID |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (application, manual) |
order_id | string | Clients` order number |
amount | string | Operation amount |
fee | string | Fee from operation amount |
amount_paid | string | Paid amount of operation |
rate | string | Exchange rate at the moment of payment |
currency | string | Currency of issued operation |
currency_paid | string | Currency in which operation will be paid |
status | string | Operation status |
address | string | Operation address |
created_at | string | Date of operation creation |
updated_at | string | Date of operation change |
payment_url | string | Link to the payment page |
redirect_url | string | Link to the page, to which redirect from payment page will be made |
transactions | array | List of operation transactions |
Transaction details:
Parameter | Type | Description |
---|---|---|
id | string | Transaction ID |
tx_id | string |
Transaction ID in Blockchain |
amount | string |
Transaction amount |
status | string | Transaction status |
linked | bool | The transaction was linked manually |
reject_reason | string |
Reason of rejecting transaction (only with reject status) |
created_at | string |
Date of transaction was created |
updated_at | string |
Date of transaction was changed |
Rates
Request:
GET |
https://api.moneypipe.com/sandbox/v1/rates |
Request headers:
Response:
200
{ "BTC:USD": 8229.424665, "USD:BTC": 0.00012152, "ETH:USD": 184.273157, "USD:ETH": 0.00542673, "ETH:BTC": 0.022392, "BTC:ETH": 44.65880672 }
Withdrawal
Request:
POST |
https://api.moneypipe.com/sandbox/v1/withdraw |
Request headers:
Request body:
{ "amount": "0.002" "wallet": "BTC", "address": "2NADN2HntfMCt7bDEjGJpSwJK6uBG8Ky1C1", }
Body details:
Parameter | Type | Description |
---|---|---|
amount * |
string |
Amount |
wallet * |
string |
Currency of wallet |
address * |
string |
Destination address |
* - required
Response:
200
{ "data": { "id": "eFbIa4lRUf3XQwlnoPmi", "application_id": null, "application_name": null, "category": "transfer", "order_id": null, "amount": "0.89418405", "fee": "0.00000000", "amount_paid": "0.89418405", "rate": "1.00018330", "currency": "BTC", "currency_paid": "BTC", "status": "processed", "address": "2NADN2HntfMCt7bDEjGJpSwJK6uBG8Ky1C1", "created_at": "2019-10-27T13:33:03.224328Z", "updated_at": "2019-10-27T13:33:03.224391Z", "payment_url": null, "redirect_url": null, "transactions": [] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string | Operation ID |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (transfer, internal_transfer) |
order_id | string | Clients` order number |
amount | string | Operation amount |
fee | string | Fee from operation amount |
amount_paid | string | Paid amount of operation |
rate | string | Exchange rate at the moment of payment |
currency | string | Currency of issued operation |
currency_paid | string | Currency in which operation will be paid |
status | string | Operation status |
address | string | Operation address |
created_at | string | Date of operation creation |
updated_at | string | Date of operation change |
payment_url | string | Link to the payment page |
redirect_url | string | Link to the page, to which redirect from payment page will be made |
transactions | array | List of operation transactions |
Voucher list
Request:
GET |
https://api.moneypipe.com/sandbox/v1/vouchers |
Request headers:
Query parameters:
Parameter | Description | For example |
---|---|---|
sort | Sort by fields: amount, status, created, updated. | sort=updated |
sort_type | Sort types: asc, desc. | sort_type=asc |
amount_from | Filter from specified amount value. | amount_from=0.001 |
amount_to | Filter to specified amount value. | amount_to=20 |
currency | Filter by currency. Values are separated by commas. | currency=ETH,btc |
status | Filter by status. Values are separated by commas | status=0 |
created_from | Filter the creation date from the specified value | created_from=2019-03-21 |
created_to | Filter the creation date from to specified value | created_to=2019-03-21 |
page | Current page number | page=2 |
per_page | How many lines to display per page | per_page=10 |
Response:
200
{ "data": [ { "id": "9c2f66286b2d1277112c", "amount": "0.00100000", "currency": "ETH", "code": "7731bad3eaaf7496a3a3ab248c3ae34b0ad1061b01fbd3c948c5dcdffe07", "status": "successful", "type": "issued", "created_at": "2020-05-04T10:05:51.000000Z", "updated_at": "2020-05-04T10:06:12.000000Z" }, { "id": "88e87a2291636152b1da", "amount": "0.02300000", "currency": "ETH", "code": "84edd9ab58ff58086f056c94ef5ad33341f8ac4fe91a0ac37c86a58aef4a", "status": "successful", "type": "issued", "created_at": "2020-05-04T09:58:58.000000Z", "updated_at": "2020-05-04T09:59:45.000000Z" }, { "id": "77b1934abb6b55af17e5", "amount": "0.01400000", "currency": "ETH", "code": "c5045a00a8bab61e2b04f38c1ea8dd0ea3bd31c62317dcf2243aca0a6a9e", "status": "successful", "type": "paid off", "created_at": "2020-04-30T09:21:44.000000Z", "updated_at": "2020-04-30T13:31:45.000000Z" } ], "links": { "first": "https://api.moneypipe.com/sandbox/v1/vouchers?page=1", "last": "https://api.moneypipe.com/sandbox/v1/vouchers?spage=1", "prev": null, "next": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "path": "https://api.moneypipe.com/sandbox/v1/vouchers", "per_page": 50, "to": 3, "total": 3 } }
Voucher details:
Parameter | Type | Description |
---|---|---|
id | string | Voucher ID |
amount | string | Voucher amount |
currency | string | Currency of issued voucher |
code | string | Code of issued voucher |
status | string | Voucher status |
type | string | Voucher type |
created_at | string | Date of voucher creation |
updated_at | string | Date of voucher change |
Voucher show
Request:
GET |
|
Request headers:
Response:
200
{ "data": { "id": "fa1a6a82df64d89453fb", "amount": "0.00482251", "currency": "ETH", "code": "4916a373a366baefa1d2a3c05935ea4c700ca653f27cd91ae1f57f0080e3", "status": "cancelled", "type": "issued", "created_at": "2020-04-30T06:14:25.000000Z", "updated_at": "2020-04-30T10:54:13.000000Z" } }
Voucher details:
Parameter | Type | Description |
---|---|---|
id | string | Voucher ID |
amount | string | Voucher amount |
currency | string | Currency of issued voucher |
code | string | Code of issued voucher |
status | string | Voucher status |
type | string | Voucher type |
created_at | string | Date of voucher creation |
updated_at | string | Date of voucher change |
Create voucher
Request:
POST |
https://api.moneypipe.com/sandbox/v1/vouchers |
Request headers:
Request body:
{ "amount": "0.012", "currency": "ETH" }
Body details:
Parameter | Type | Description |
---|---|---|
amount * |
string |
Amount set |
currency * |
string |
Currency of voucher |
* - required
Response:
201
{ "data": { "id": "0abbdb1117499a4e6cbd", "amount": "0.012", "currency": "ETH", "code": "6f7b34f9bfb5290ae8f6c87c512c5eee8baaa8a90d233b9b658ca98352a1", "status": "new", "type": "issued", "created_at": "2020-05-04T14:01:25.000000Z", "updated_at": "2020-05-04T14:01:25.000000Z" } }
Voucher details:
Parameter | Type | Description |
---|---|---|
id | string | Voucher ID |
amount | string | Voucher amount |
currency | string | Currency of issued voucher |
code | string | Code of issued voucher |
status | string | Voucher status |
type | string | Voucher type |
created_at | string | Date of voucher creation |
updated_at | string | Date of voucher change |
Cancel voucher
Request:
PUT |
https://api.moneypipe.com/sandbox/v1/vouchers/{voucher_id}/cancel |
Request headers:
Response:
204
Pay off voucher
Request:
POST |
https://api.moneypipe.com/sandbox/v1/vouchers/payoff |
Request headers:
Request body:
{ "code": "7731bad3eaaf7496a3a3ab248c3ae34b0ad1061b01fbd3c948c5dcdffe07" }
Body details:
Parameter | Type | Description |
---|---|---|
code * |
string |
Code of voucher |
* - required
Response:
201
{ "data": { "id": "0abbdb1117499a4e6cbd", "amount": "0.0112", "currency": "ETH", "code": "7731bad3eaaf7496a3a3ab248c3ae34b0ad1061b01fbd3c948c5dcdffe07", "status": "successful", "type": "paid off", "created_at": "2020-05-04T14:01:25.000000Z", "updated_at": "2020-05-04T14:01:25.000000Z" } }
Voucher details:
Parameter | Type | Description |
---|---|---|
id | string | Voucher ID |
amount | string | Voucher amount |
currency | string | Currency of issued voucher |
code | string | Code of issued voucher |
status | string | Voucher status |
type | string | Voucher type |
created_at | string | Date of voucher creation |
updated_at | string | Date of voucher change |
Create Exchange
Request:
POST |
https://api.moneypipe.com/sandbox/v1/exchange |
Request headers:
Request body:
{ "sell_currency": "BTC", "buy_currency": "ETH", "sell_amount": "0.00024865", "buy_amount": "0.01" }
Body details:
Parameter | Type | Description |
---|---|---|
sell_currency * |
string |
Сurrency for sale |
buy_currency * |
string |
Сurrency to buy |
sell_amount ** |
string |
Amount for sale |
buy_amount ** |
string |
Amount to buy |
* - required
** - one of the two fields is required
Response:
201
{ "data": { "id": "0abbdb1117499a4e6cbd", "application_id": null, "application_name": null, "category": "exchange", "order_id": null, "amount": "0.00024865", "fee": "0.00010000", "amount_paid": "0.01", "rate": "47.14147063", "currency": "BTC", "currency_paid": "ETH", "status": "processed", "address": null, "created_at": "2020-05-04T14:01:25.000000Z", "updated_at": "2020-05-04T14:01:25.000000Z", "payment_url": null, "redirect_url": null, "transactions": [] } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string |
Operation id |
application_id | string |
Application id |
application_name | string | Application name |
category | string | Operation category (application, manual) |
order_id | string |
Sales order number |
amount | string |
Operation amount |
fee | string |
Fee of the operation amount |
amount_paid | string |
Paid operation amount |
rate | string |
Exchange rate at the moment of payment |
currency | string |
Currency in which the operation was issued |
currency_paid | string |
Currency in which the operation will be paid |
status | string |
Operation status |
address | string |
Operation address |
created_at | string |
Operation creation date |
updated_at | string |
Operation change date |
payment_url | string |
Link to the payment page |
redirect_url | string |
Page link, to which there will be a redirect from the payment page |
transactions | array |
Operation transaction List |
Exchange Rates
Request:
GET |
https://api.moneypipe.com/sandbox/v1/exchange/rates |
Request headers:
Query parameters:
Parameter | Description | For example |
---|---|---|
pair | Filter by currency pair. Values are separated by commas. | pair=BTC:ETH,BTC:BNB |
Response:
200
{ "BTC:ETH": { "rate": "47.14147063", "fee": "0.00000000", "min_limit": "0.00000010", "max_limit": "1.00000000" }, "BNB:ETH": { "rate": "0.08388443", "fee": "0.04000000", "min_limit": "0.00122223", "max_limit": "0.02000000" }, "BNB:BTC": { "rate": "0.001815", "fee": "1.00000000", "min_limit": "0.00000000", "max_limit": "0.00010000" }, "BTC:BNB": { "rate": "552.0661157", "fee": "0.00000000", "min_limit": "0.00000000", "max_limit": "1.00000000" }, "ETH:BNB": { "rate": "11.94505418", "fee": "0.00000000", "min_limit": "0.00000000", "max_limit": "0.00000000" }, "ETH:BTC": { "rate": "0.0238007", "fee": "0.00010000", "min_limit": "0.00001000", "max_limit": "1.00000000" } }
Create Cross Exchange
Request:
POST |
https://api.moneypipe.com/sandbox/v1/cross-exchanges |
Request headers:
Request body:
{ "sell_currency": "BTC", "buy_currency": "ETH", "sell_amount": "0.00024865", "buy_amount": "0.01", "sell_address": "2MxrLNgYJS5MM53XTVLc5QcAM4EwwfoDgy7", "buy_address": "0x2c951247ecdc0cf12f69f8302e6e6eda2b33abe1" }
Body details:
Parameter | Type | Description |
---|---|---|
sell_currency * |
string |
Сurrency for sale |
buy_currency * |
string |
Сurrency to buy |
sell_amount ** |
string |
Amount for sale |
buy_amount ** |
string |
Amount to buy |
sell_address * |
string |
Address to which funds will be refunded in case of unsuccessful cross-exchange |
buy_address * |
string |
The address to which funds will be credited in case of a successful cross-exchange |
* - required
** - one of the two fields is required
Response:
201
{ "data": { "id": "e5302b942164be5bed4c", "operation_id": "0abbdb1117499a4e6cbd", "sell_currency": "BTC", "buy_currency": "ETH", "sell_amount": "0.00024865", "buy_amount": "0.01", "fee": "0", "rate": "46.23712807", "invoice_address": "2MxytWgaJS5MM53XTVLc5QcAM4Ewwfopat8", "status": "processed", "expired_at": "2020-05-04T15:01:25.000000Z", "created_at": "2020-05-04T14:01:25.000000Z", "updated_at": "2020-05-04T14:01:25.000000Z" } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string |
Cross exchange id |
operation_id | string |
Operation id |
sell_currency | string | Сurrency for sale |
buy_currency | string | Сurrency to buy |
sell_amount | string |
Amount for sale |
buy_amount | string |
Amount to buy |
fee | string |
Fee of the cross exchange amount |
rate | string |
Cross exchange rate at the moment of payment |
invoice_address | string | Cross exchange address |
status | string | Cross exchange status |
expired_at | string | Cross exchange expiration date |
created_at | string | Cross exchange creation date |
updated_at | string | Cross exchange change date |
Show Cross Exchange
Request:
GET |
https://api.moneypipe.com/sandbox/v1/cross-exchanges/{cross_exchange_id} |
Request headers:
Response:
200
{ "data": { "id": "e5302b942164be5bed4c", "operation_id": "0abbdb1117499a4e6cbd", "sell_currency": "BTC", "buy_currency": "ETH", "sell_amount": "0.00024865", "buy_amount": "0.01", "fee": "0", "rate": "46.23712807", "invoice_address": "2MxytWgaJS5MM53XTVLc5QcAM4Ewwfopat8", "status": "processed", "expired_at": "2020-05-04T15:01:25.000000Z", "created_at": "2020-05-04T14:01:25.000000Z", "updated_at": "2020-05-04T14:01:25.000000Z" } }
Operation details:
Parameter | Type | Description |
---|---|---|
id | string |
Cross exchange id |
operation_id | string |
Operation id |
sell_currency | string | Сurrency for sale |
buy_currency | string | Сurrency to buy |
sell_amount | string |
Amount for sale |
buy_amount | string |
Amount to buy |
fee | string |
Fee of the cross exchange amount |
rate | string |
Cross exchange rate at the moment of payment |
invoice_address | string | Cross exchange address |
status | string | Cross exchange status |
expired_at | string | Cross exchange expiration date |
created_at | string | Cross exchange creation date |
updated_at | string | Cross exchange change date |
Cancel Cross Exchange
Request:
PUT |
https://api.moneypipe.com/sandbox/v1/cross-exchanges/{cross_exchange_id}/cancel |
Request headers:
Response:
204