paymasterBalance

Learn how to use the paymasterBalance JSON-RPC method.

POST /#pm_paymasterBalance

paymasterBalance

cURL

curl --request POST \
  --url 'https://paymaster.particle.network/#pm_paymasterBalance' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jsonrpc": "2.0",
  "id": 0,
  "method": "pm_paymasterBalance",
  "params": [
    "<unknown>"
  ]
}
'

200

{
  "jsonrpc": "2.0",
  "id": 0,
  "result": {
    "balance": "0xBalance"
  }
}

Understanding paymasterBalance

• paymasterBalance returns the USD balance (6 decimals) of the Paymaster associated with your projectId (projectUuid) and serverKey (projectKey). It takes no parameters other than the projectUuid and projectKey for authentication.

---

Query example

JavaScript

import Axios from "axios";

const projectUuid = "Your project uuid";
const projectKey = "Your project client key or server key";

const paymasterUrl = "https://paymaster.particle.network";
(async () => {
    const response = await Axios.post(
        paymasterUrl,
        {
            method: "pm_paymasterBalance",
            params: [],
        },
        {
            params: {
                projectUuid,
                projectKey,
            },
        }
    );

    console.log(response.data);
})();

Query Parameters

projectUuid · string · required

UUID of the project.

projectKey · string · required

Key of the project.

Body

application/json

Request to retrieve the balance of the paymaster.

jsonrpc · string · default: 2.0 · required

Version of the JSON-RPC protocol, should be 2.0.

Example:

"2.0"

id · integer · default: 0 · required

The request identifier.

Example:

0

method · enum<string> · required

API method being called.

Available options: pm_paymasterBalance

params · any[] · required

No parameters are needed for this request.

Response

200 - application/json

Successful response with the paymaster balance.

jsonrpc · string · default: 2.0 · required

Version of the JSON-RPC protocol, should be 2.0.

Example:

"2.0"

id · integer · default: 0 · required

The request identifier.

Example:

0

result · object · required

Show child attributes