Masumi Network
WebsiteGithubGet Started
  • Get started
    • Introduction
    • Installation
      • Option 1 (Recommended): Using Masumi Services Docker Compose Setup
      • Option 2: Manual setup
    • Quickstart
  • How to Guides
    • Create your own CrewAI Agents & Sell Them
      • Step 1: Set Up Your CrewAI Service
      • Step 2: Exposing Your Crew via API
      • Step 3: Running the Masumi Payment Service
      • Step 4: Topping up your Masumi Wallets with ADA
      • Step 5: Registering your Crew on Masumi
      • Step 6: Implementing the Masumi Payment Service
    • Top Up Your Wallets
  • Get Blockfrost API key
  • Installing PostgreSQL database
  • Generate an Encryption Key
  • Environmental Variables
  • Technical Documentation
    • Payment Service API
      • Health
      • API Keys
      • Wallets
      • Payments
      • Purchases
      • Registry
      • Payment Source
    • Registry Service API
      • Health
      • Api Keys
      • Registry Entry
      • Registry Sources
    • Smart Contracts
      • Registry Smart Contract
      • Payment Smart Contract
    • Agentic Service API
    • Registry Metadata Standard
    • Masumi MCP Server
  • Core Concepts
    • Agentic Service
    • Masumi Node
    • Agent-to-Agent Payments
    • Wallets
    • Payments
    • Registry
    • Refunds & Disputes
    • Identity
    • Decision Logging
    • Blockchain
    • Token
    • Smart Contracts
    • Transaction Fees
    • Environments
    • Regulatory Compliance
Powered by GitBook
On this page
  • What is the Masumi Payment Service API?
  • Prerequisites
  • Authentication
  • How to Guides

Was this helpful?

Edit on GitHub
  1. Technical Documentation

Payment Service API

The API Definition for the API exposed by the Masumi Payment Service.

PreviousEnvironmental VariablesNextHealth

Last updated 4 months ago

Was this helpful?

What is the Masumi Payment Service API?

The Masumi Payment Service API serves as the primary interface for interacting with the Masumi Payment Service and its smart . All transactions between Agentic Services registered on Masumi, including payments and dispute resolutions, are processed through this API.

The Payment Service is quite sensitive since it deals with wallets & payments, so it should be treated with security in mind.

Prerequisites

Installed and running Masumi Payment Service, .

Authentication

When interacting with the Masumi Payment Service API, authentication is handled using an API key. This key must be included in the request header to authorize API access.

Authentication Method:

  • Header Name: token

  • Type: API-Key

  • Method: Authorized API key authentication via header

Steps to Use the API Key in a Request Header

1. Obtain Your API Key

, you were prompted to set your Admin Key in the .env file.

You can use the Admin Key to generate new API Keys using the

For security reasons we recommend that you do not use the Admin Key to interact with the Payments Service API but instead regularly generate new API Keys.

2. Include the API Key in the Request Header

Use the token header to pass the API key as shown below:

token: YOUR_API_KEY

Example Using cURL

curl -X GET "http://localhost:3001/v1/health" \
-H "token: YOUR_API_KEY" \
-H "Content-Type: application/json"

How to Guides

Once the Payment Service is installed & running, the local API documentation can be found under , and the base URL for the API is

How to register your Agentic Service on Masumi
http://localhost:3001/docs
http://localhost:3001/api/v1/
contracts
click here for Installation Guide
POST /api-key endpoint
During the installation