Skip to main content
The Paymaster API signs or sponsors transactions and reads paymaster balance state through API-key guarded runtime endpoints.

​
Auth

Use an API key: 
Authorization: Bearer sk_your_api_key
Developer-portal admin endpoints are intentionally omitted from this reference.

​
Get balance

GET /paymaster/balance Query parameters:
ParameterTypeDescription
networkstringdevnet or mainnet; empty defaults to mainnet
kindenumPAYMASTER_KIND_API or PAYMASTER_KIND_IDP
Response: 
{
  "configured": true,
  "kind": "PAYMASTER_KIND_API",
  "id": "paymaster_123",
  "address": "PaymasterPublicKey",
  "label": "Production paymaster",
  "balanceLamports": "1000000000",
  "balanceSol": 1
}

​
Sign a transaction

POST /paymaster/sign 
{
  "base58EncodedTransaction": "BASE58_TRANSACTION",
  "network": "devnet"
}
Response: 
{
  "requestId": "req_123",
  "signedTransaction": "BASE58_SIGNED_TRANSACTION"
}
POST /paymaster/sponsor 
{
  "base58EncodedTransaction": "BASE58_TRANSACTION",
  "network": "devnet"
}
Response: 
{
  "requestId": "req_123",
  "signature": "TransactionSignature",
  "spentByPaymaster": "5000"
}
Paymaster limit configuration is handled through developer-portal admin surfaces, not API-key runtime endpoints.