Wallet API

Search…
Wallet API
Public Wallet API Reference
This website documents the public API for PlasmaPay Public Wallet​
You can view code examples in the dark area to the right; switch the programming language of the examples with the tabs in the top right.
Webhook
Shell
JS
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
5
​
6
POST 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
7
​
8
DELETE 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
9
​
Copied!
1
ENDPOINTS:
2
​
3
GET 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
4
​
5
POST 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
6
​
7
DELETE 'https://app.plasmapay.com/business/api/v1/wallet/webhooks'
Copied!
You must use your `API_KEY` for any request to the server. Using an request without `API_KEY` will return an error.
GET /webhooks
Get all webhooks
Shell
JS
1
curl
2
  -X GET
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/webhooks
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/webhooks',
6
  method: 'GET',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
Shell
JS
1
200 Ok
2
Content-Type: application/json
Copied!
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
Shell
JS
1
[{
2
   "id": "{ID}",
3
   "username": "{USERNAME}",
4
   "url": "{URL}",
5
}]
Copied!
1
[{
2
   "id": "{ID}",
3
   "username": "{USERNAME}",
4
   "url": "{URL}",
5
}]
Copied!
In order to get all webhooks from the server you must make a GET request to
GET https://app.plasmapay.com/business/api/v1/wallet/webhooks
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
EXAMPLE REQUEST
1
GET https://app.plasmapay.com/business/api/v1/wallet/webhooks
Copied!
EXAMPLE RESPONSE
1
[{
2
   "id": "5d2ea0dea7f3cd480a973b5e",
3
   "username": "testusername",
4
   "url": "https://your-site.com/webhook/test",
5
}]
Copied!
POST /webhooks
Create a webhook by sending data via post
Shell
JS
1
curl
2
  -X POST
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/webhooks
6
  -d '{"username": "{USERNAME}", "url": "{URL}" }'
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/webhooks',
6
  method: 'POST',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: {
12
    "username": "{USERNAME}",
13
    "url": "{URL}"
14
  }
15
}
16
​
17
​
18
​
19
request(options, function (error, response, body) {
20
  if (!error && response.statusCode === 200) {
21
    // Handle body
22
  }
23
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
{
2
   "id": "{ID}",
3
   "username": "{USERNAME}",
4
   "url": "{URL}",
5
}
Copied!
In order to create a new webhook on the server you must make a POST request to
POST https://app.plasmapay.com/business/api/v1/wallet/webhooks
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
Parameter
Meaning
username={USERNAME}
Plasma network account (required)
url={URL}
URL for webhooks sending (required)
EXAMPLE REQUEST
1
POST https://app.plasmapay.com/business/api/v1/wallet/webhooks
2
​
3
{
4
 "username": "testaccount",
5
 "url": "https://site.com/test"
6
}
Copied!
EXAMPLE RESPONSE
1
{
2
   "id": "5d2ea0dea7f3cd480a973b5e",
3
   "username": "testusername",
4
   "url": "https://your-site.com/webhook/test",
5
}
Copied!
Receiving data via webhooks
POST to provided url
After setting new webhook you will be available to receive 3 types of events about transactions from plasma blockchain:
1. New Plasma transaction (pending state)
EXAMPLE BODY 1
Shell
JS
1
{
2
   "eventType": "new",
3
    "tx": {
4
        "type": "withdraw",
5
        "from": "testacc22222",
6
        "to": "plasma.coin",
7
        "quantity": 0.9999,
8
        "currency": "RUBP",
9
        "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
        "fee": {
11
            "quantity": 0.0001,
12
            "currency": "RUBP"
13
        },
14
         "blockNum": 21643484,
15
         "timestamp": "2019-10-01T12:51:16.000",
16
         "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
         "mainAction": {
18
             "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
             "name": "withdraw",
20
             "account": "rubp",
21
             "data": {
22
                "account": "testacc22222",
23
                "quantity": "1000000000000000000",
24
                "paySysCms": 0
25
             },
26
             "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
             "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
             "actors": [
29
                "testacc22222"
30
             ]
31
         }
32
    }
33
}
Copied!
1
{
2
   "eventType": "new",
3
    "tx": {
4
        "type": "withdraw",
5
        "from": "testacc22222",
6
        "to": "plasma.coin",
7
        "quantity": 0.9999,
8
        "currency": "RUBP",
9
        "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
        "fee": {
11
            "quantity": 0.0001,
12
            "currency": "RUBP"
13
        },
14
         "blockNum": 21643484,
15
         "timestamp": "2019-10-01T12:51:16.000",
16
         "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
         "mainAction": {
18
             "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
             "name": "withdraw",
20
             "account": "rubp",
21
             "data": {
22
                "account": "testacc22222",
23
                "quantity": "1000000000000000000",
24
                "paySysCms": 0
25
             },
26
             "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
             "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
             "actors": [
29
                "testacc22222"
30
             ]
31
         }
32
    }
33
}
Copied!
Where tx.type can be one of these options: 'withdraw', 'transfer', 'newaccount', 'permissions', 'issue', 'exchange'
tx.tx contains all the data about transaction in blockchain network
2. Confirmation of Plasma transaction (success state)
EXAMPLE BODY 2
Shell
JS
1
{
2
   "eventType": "confirm",
3
   "tx": {
4
           "type": "withdraw",
5
           "from": "testacc22222",
6
           "to": "plasma.coin",
7
           "quantity": 0.9999,
8
           "currency": "RUBP",
9
           "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
           "fee": {
11
               "quantity": 0.0001,
12
               "currency": "RUBP"
13
           },
14
            "blockNum": 21643484,
15
            "timestamp": "2019-10-01T12:51:16.000",
16
            "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
            "mainAction": {
18
                "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
                "name": "withdraw",
20
                "account": "rubp",
21
                "data": {
22
                   "account": "testacc22222",
23
                   "quantity": "1000000000000000000",
24
                   "paySysCms": 0
25
                },
26
                "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
                "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
                "actors": [
29
                   "testacc22222"
30
                ]
31
            }
32
       }
33
}
Copied!
1
{
2
   "eventType": "confirm",
3
   "tx": {
4
           "type": "withdraw",
5
           "from": "testacc22222",
6
           "to": "plasma.coin",
7
           "quantity": 0.9999,
8
           "currency": "RUBP",
9
           "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
           "fee": {
11
               "quantity": 0.0001,
12
               "currency": "RUBP"
13
           },
14
            "blockNum": 21643484,
15
            "timestamp": "2019-10-01T12:51:16.000",
16
            "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
            "mainAction": {
18
                "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
                "name": "withdraw",
20
                "account": "rubp",
21
                "data": {
22
                   "account": "testacc22222",
23
                   "quantity": "1000000000000000000",
24
                   "paySysCms": 0
25
                },
26
                "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
                "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
                "actors": [
29
                   "testacc22222"
30
                ]
31
            }
32
       }
33
}
Copied!
3. Cancelling of Plasma transaction (canceled state)
EXAMPLE BODY 3
Shell
JS
1
{
2
   "eventType": "cancel",
3
   "tx": {
4
           "type": "withdraw",
5
           "from": "testacc22222",
6
           "to": "plasma.coin",
7
           "quantity": 0.9999,
8
           "currency": "RUBP",
9
           "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
           "fee": {
11
               "quantity": 0.0001,
12
               "currency": "RUBP"
13
           },
14
            "blockNum": 21643484,
15
            "timestamp": "2019-10-01T12:51:16.000",
16
            "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
            "mainAction": {
18
                "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
                "name": "withdraw",
20
                "account": "rubp",
21
                "data": {
22
                   "account": "testacc22222",
23
                   "quantity": "1000000000000000000",
24
                   "paySysCms": 0
25
                },
26
                "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
                "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
                "actors": [
29
                   "testacc22222"
30
                ]
31
            }
32
       }
33
}
Copied!
1
{
2
   "eventType": "cancel",
3
   "tx": {
4
           "type": "withdraw",
5
           "from": "testacc22222",
6
           "to": "plasma.coin",
7
           "quantity": 0.9999,
8
           "currency": "RUBP",
9
           "actionId": "b4ca93c86297d983f1c156882439fa156c26fdc7ec35956735b7fbf44dfa2de1",
10
           "fee": {
11
               "quantity": 0.0001,
12
               "currency": "RUBP"
13
           },
14
            "blockNum": 21643484,
15
            "timestamp": "2019-10-01T12:51:16.000",
16
            "blockId": "014a40dcb8aea7bb0e2e47fccde0cf0eb50619b0baa0c38c3da22a5a034b6b74",
17
            "mainAction": {
18
                "actionId": "1e0d89edf2bc33f29f8554751f1bf9bbe1e5e95cef123f1fe2a5d2da521be40a",
19
                "name": "withdraw",
20
                "account": "rubp",
21
                "data": {
22
                   "account": "testacc22222",
23
                   "quantity": "1000000000000000000",
24
                   "paySysCms": 0
25
                },
26
                "txId": "ceb8c5a1f94dc3fea09aa0f05ed7fdcbad46365728ed5d748fb6ba11756120f6"
27
                "console": " Taking fee from amount 1.000000000000000000 RUBP. Converted to 0.020932000000000000 PLASMA from 1.000000000000000000 RUBP mult 20932 div 1000000. Fee is 1/100 % - 0.000100000000000000 RUBP. Fee is 1/100 % - 0.000002093200000000 PLASMA. Calculated fee amount is 0.000100000000000000 RUBP.",
28
                "actors": [
29
                   "testacc22222"
30
                ]
31
            }
32
       }
33
}
Copied!
DELETE /webhooks/{id}
Delete a webhook by sending data via delete
Shell
JS
1
curl
2
  -X DELETE
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/webhooks/{id}
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/webhooks/{id}',
6
  method: 'DELETE',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
{
2
  success: {SUCCESS}
3
}
Copied!
In order to delete a webhook on the server you must make a DELETE request to
DELETE https://app.plasmapay.com/business/api/v1/wallet/webhooks/{id}
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
EXAMPLE REQUEST
1
DELETE https://app.plasmapay.com/business/api/v1/wallet/webhooks?id=5d2ea0dea7f3cd480a973b5e
Copied!
EXAMPLE RESPONSE
1
{
2
   "success": true
3
}
Copied!
Rates
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/rates/{pair}'
5
​
Copied!
​
You must use your `API_KEY` for any request to the server. Using an request without `API_KEY` will return an error.
GET /rates/{pair}
Get rate of one currency to another
Shell
JS
1
curl
2
  -X GET
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/rates/{pair}
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/rates/{pair}',
6
  method: 'GET',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
{
2
   "pair": "{PAIR}",
3
   "rate": "{RATE}",
4
}
Copied!
In order to get rates from the server you must make a GET request to
GET https://app.plasmapay.com/business/api/v1/wallet/rates/{pair}
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
EXAMPLE REQUEST
1
GET https://app.plasmapay.com/business/api/v1/wallet/rates/PLASMA-USDP
Copied!
EXAMPLE RESPONSE
1
{
2
     "pair": "PLASMA-USDP",
3
     "rate": "1.1",
4
}
Copied!
Currency code 
Currency
Code
US Dollar
USDP
Euro
EURP
Pound Sterling
GBPP
Chinese Yuan
CYNP
Russian Ruble
RUBP
Czech Republic Koruna
CZKP
Singapore Dollar
SGDP
Hong Kong Dollar
HKDP
South Korean Won
KRW
Hungarian Forint
HUFP
Israeli New Sheqel
ILSP
Norwegian Krone
NOKP
Kenyan Shilling
KESP
Philippine Peso
PHPP
Indian Rupee
INRP
Pakistani Rupee
PKRP
Argentine Peso
ARSP
Australian dollar
AUDP
Belarusian Ruble
BYNP
Indonesian Rupiah
IDRP
Danish Krone
DKKP
Thai Baht
THBP
Mexican Peso
MXNP
Swedish Krona
SEKP
Japanese Yen
JPYP
Chilean Peso
CLPP
Azerbaijani Manat
AZNP
Armenian Dram
AMDP
Brazilian Real
BRLP
Swiss Franc
CHFP
New Taiwan Dollar
TWDP
Nigerian Naira
NGNP
Canadian Dollar
CADP
Turkish Lira
TRYP
Kazakhstani Tenge
KZTP
New Zealand Dollar
NZDP
Malaysian Ringgit
MYRP
Omani Rial
OMRP
Vietnamese Dong
VNDP
South African Rand
ZARP
Polish Zloty
PLNP
Ukraine Hryvnia
UAHP
Fees
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/fees/{tokenCode}'
5
​
Copied!
 
You must use your `API_KEY` for any request to the server. Using an request without `API_KEY` will return an error.
GET /fees/{tokenCode}
Get fees from plasma blockchain network
Shell
JS
1
curl
2
  -X GET
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/fees/{tokenCode}
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/fees/{tokenCode}',
6
  method: 'GET',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
{
2
      "plasma": {
3
           "balance": "{BALANCE}",
4
           "minFee": "{MINER_FEE}",
5
           "decimals": "{DECIMALS}",
6
           "currencyRate": "{CURRENCY_RATE}",
7
           "feePercents": "{FEE_PERCENTS}",
8
           "exchangeFeePercents": "{EXCHANGE_FEE_PERCENTS}"
9
       },
10
       "currency": {
11
            "balance": "{BALANCE}",
12
            "minFee": "{MINER_FEE}",
13
            "decimals": "{DECIMALS}",
14
            "currencyRate": "{CURRENCY_RATE}",
15
            "feePercents": "{FEE_PERCENTS}",
16
            "exchangeFeePercents": "{EXCHANGE_FEE_PERCENTS}"
17
       }
18
}
Copied!
In order to get fees from the server you must make a GET request to
GET https://app.plasmapay.com/business/api/v1/wallet/fees/{tokenCode}
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.

EXAMPLE REQUEST
1
GET https://app.plasmapay.com/business/api/v1/wallet/fees/RUBP
Copied!
EXAMPLE RESPONSE
1
{
2
    "plasma": {
3
        "balance": "0",
4
        "minFee": 1,
5
        "decimals": 18,
6
        "currencyRate": 49.345366,
7
        "feePercents": 0.00005,
8
        "exchangeFeePercents": 0.001
9
    },
10
    "currency": {
11
        "balance": "500000000000000000000",
12
        "minFee": 1,
13
        "plasmaRate": 0.020265,
14
        "decimals": 18,
15
        "feePercents": 0.0001,
16
        "exchangeFeePercents": 0.001
17
    }
18
}
Copied!
Accounts
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/accounts/{account}/available'
5
​
Copied!
 
You must use your `API_KEY` for any request to the server. Using an request without `API_KEY` will return an error.
GET /accounts/{account}/available
Check if account exist and available in the plasma blockchain network
Bash
JS
1
curl
2
  -X GET
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/accounts/{account}/available
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/accounts/{account}/available',
6
  method: 'GET',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
{
2
      "available": "{AVAILABLE}"
3
}
Copied!
In order to check if account exist and available from the server you must make a GET request to
GET https://app.plasmapay.com/business/api/v1/wallet/accounts/{account}/available
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
EXAMPLE REQUEST
1
GET https://app.plasmapay.com/business/api/v1/wallet/accounts/testaccount/available
Copied!
EXAMPLE RESPONSE
1
{
2
    "available": true
3
}
Copied!
Balances
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/balances/{username}'
5
​
Copied!
 
You must use your `API_KEY` for any request to the server. Using an request without `API_KEY` will return an error.
GET /balances/{username}
Get balances for plasma account
Shell
JS
1
curl
2
  -X GET
3
  -H "Content-type: application/json"
4
  -H "authorization: Bearer <API_KEY>"
5
  https://app.plasmapay.com/business/api/v1/wallet/balances/{username}
Copied!
1
var request = require('request');
2
​
3
​
4
const options = {
5
  uri: 'https://app.plasmapay.com/business/api/v1/wallet/balances/{username}',
6
  method: 'GET',
7
  headers: {
8
    'Content-Type': 'application/json',
9
    'authorization': 'Bearer API_KEY'
10
  },
11
  json: true
12
}
13
​
14
​
15
​
16
request(options, function (error, response, body) {
17
  if (!error && response.statusCode === 200) {
18
    // Handle body
19
  }
20
});
Copied!
RESPONSE
1
200 Ok
2
Content-Type: application/json
Copied!
BODY
1
[{
2
   "account": "{ACCOUNT}",
3
   "balance": "{BALANCE}",
4
}]
Copied!
In order to get balances from the server you must make a GET request to
GET https://app.plasmapay.com/business/api/v1/wallet/balances/{username}
with the apiKey as query parameter or Bearer <API_KEY> as authorization header.
EXAMPLE REQUEST
1
GET https://app.plasmapay.com/business/api/v1/wallet/balances/testaccount
Copied!
EXAMPLE RESPONSE
1
[
2
    {
3
        "account": "testaccount",
4
        "balance": 200,
5
        "currency": "RUBP"
6
    },
7
    {
8
        "account": "testaccount",
9
        "balance": 3,
10
        "currency": "USDP"
11
    }
12
]
Copied!
Transactions
1
​
2
ENDPOINTS:
3
​
4
GET 'https://app.plasmapay.com/business/api/v1/wallet/transactions/{txId}'
5
POST 'https://app.plasmapay.com/business/api/v1/wallet/transactions'
6
​