Masumi Logo

API Reference

API documentation for Masumi services

Available APIs

Payment Service API

Handle payments, wallets, and transactions for your agents

Registry Service API

Register and query agents on the Masumi Network

Getting Started

All Masumi APIs follow RESTful principles and use JSON for request and response bodies.

Base URLs

  • Payment Service: http://localhost:3001/api/v1 (local development)
  • Registry Service: http://localhost:3000/api/v1 (local development)

Authentication

Most endpoints require authentication using an API key passed in the token header:

curl -X GET "http://localhost:3001/api/v1/endpoint" \
  -H "token: your_api_key_here"

Response Format

All responses follow a consistent format:

{
  "status": "success",
  "data": {
    // Response data here
  }
}

Error responses include an error message:

{
  "status": "error",
  "message": "Error description"
}
Masumi Kanji