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>"
  ]
}
'

import requests

url = "https://paymaster.particle.network/#pm_paymasterBalance"

payload = {
    "jsonrpc": "2.0",
    "id": 0,
    "method": "pm_paymasterBalance",
    "params": ["<unknown>"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({jsonrpc: '2.0', id: 0, method: 'pm_paymasterBalance', params: ['<unknown>']})
};

fetch('https://paymaster.particle.network/#pm_paymasterBalance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://paymaster.particle.network/#pm_paymasterBalance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jsonrpc' => '2.0',
    'id' => 0,
    'method' => 'pm_paymasterBalance',
    'params' => [
        '<unknown>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://paymaster.particle.network/#pm_paymasterBalance"

	payload := strings.NewReader("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 0,\n  \"method\": \"pm_paymasterBalance\",\n  \"params\": [\n    \"<unknown>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://paymaster.particle.network/#pm_paymasterBalance")
  .header("Content-Type", "application/json")
  .body("{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 0,\n  \"method\": \"pm_paymasterBalance\",\n  \"params\": [\n    \"<unknown>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://paymaster.particle.network/#pm_paymasterBalance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jsonrpc\": \"2.0\",\n  \"id\": 0,\n  \"method\": \"pm_paymasterBalance\",\n  \"params\": [\n    \"<unknown>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

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