Mayar MCP Documentation

What is MCP?

The Model Context Protocol (MCP) is an open standard that enables AI models to securely connect to external data sources and tools. It provides a unified way for AI applications to interact with various services, databases, and APIs while maintaining security and proper access controls.

MCP servers act as bridges between AI models and external systems, allowing models to:

Access real-time data from external services
Execute functions and operations on behalf of users
Maintain secure authentication and authorization
Provide structured responses that models can understand

The Mayar MCP Server specifically provides AI models with comprehensive access to payment processing, customer management, and transaction data through a secure, standardized interface.

Total Tools

🖥️ MCP Client Integration

To connect Mayar MCP Server to an MCP client application such as Claude Desktop, Cursor, or others, add the following configuration in Settings > Developer > Edit Config in your app. Replace your-api-key as needed.

{
  "mcpServers": {
    "mayar": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.mayar.id/sse",
        "--header",
        "Authorization:${API_KEY}"
      ],
      "env": {
        "API_KEY": "your-api-key"
      }
    }
  }
}

Connection Details

Connection Type: SSE
Server URL: https://mcp.mayar.id/sse

Headers

Authorization: [Mayar_API_Key]

Environment Variables

API_KEY
Your Mayar API key for authentication

🔑 Getting Your API Key

You can obtain your Mayar API Key in Mayar Dashboard > Integration > Api Keys.

💰 Account Management

get_balance

Retrieve your current Mayar account balance. Useful for monitoring cash flow and available balance.

get_balance

get_payment_channels

Retrieve configured payment channels for your merchant account (QRIS, VA, e-wallet, etc.).

get_payment_channels

🧾 Invoice Management

create_invoice

Create a new invoice for a customer. Supports multiple payment methods and invoice detail customization.

create_invoice

get_all_invoices

Get a list of all invoices with status and search filtering.

get_all_invoices

get_invoice_detail

Retrieve detailed invoice information by UUID.

get_invoice_detail

update_invoice

Update an existing invoice (items, description, expiration, etc.).

update_invoice

👥 Customer Management

send_portal_link

Send a customer portal link for dashboard access and transaction history.

send_portal_link

get_customer_detail

Retrieve detailed customer information by email, including contact data and membership status.

get_customer_detail

get_all_customers

Get a list of all customers with filtering and pagination support.

get_all_customers

create_customer

Create a new customer record with name, email, and mobile.

create_customer

update_customer

Merge or archive a customer by updating their email.

update_customer

💳 Transaction Management

get_latest_transactions

Get the latest paid transactions. Ideal for real-time activity monitoring.

get_latest_transactions

get_latest_transactions_by_customer

Get the latest transactions for a specific customer and product. Useful for customer service and support.

get_latest_transactions_by_customer

get_transactions_by_time_period

Filter transactions by time period (day, week, month, year). Suitable for periodic reporting.

get_transactions_by_time_period

get_transactions_by_time_range

Filter transactions within a specific date range. More flexible for custom analysis.

get_transactions_by_time_range

get_transactions_by_customer_and_time_range

Combine customer and date range filters for in-depth per-customer analysis.

get_transactions_by_customer_and_time_range

get_transactions_by_customer_and_time_period

Filter customer transactions within a certain period. Ideal for customer retention analysis.

get_transactions_by_customer_and_time_period

get_transactions_by_specific_product

Analyze transactions per product for tracking performance and item popularity.

get_transactions_by_specific_product

get_daily_transaction_stats

Get daily transaction statistics (TPV count and transaction count) for quick overview.

get_daily_transaction_stats

🎯 Membership Management

get_membership_customer_by_specific_product

Get a list of members by specific membership product. Useful for targeted marketing.

get_membership_customer_by_specific_product

get_membership_customer_by_specific_product_and_tier

Filter members by product and membership tier. Ideal for premium customer segmentation.

get_membership_customer_by_specific_product_and_tier

get_membership_tier_list

Get a list of membership tiers for a specific product.

get_membership_tier_list

get_membership_member_detail

Get detailed information about a specific membership member.

get_membership_member_detail

create_membership_member

update_membership_member

Update membership member details or status.

update_membership_member

create_membership_invoice

Create a new invoice for an existing membership member.

create_membership_invoice

cancel_membership_member

Cancel a membership member subscription.

cancel_membership_member

⚠️ Unpaid Transactions

get_latest_unpaid_transactions

Monitor unpaid invoices. Important for cash flow management and follow-up.

get_latest_unpaid_transactions

get_unpaid_transactions_by_time_range

Filter unpaid transactions within a specific time range for debt collection strategy.

get_unpaid_transactions_by_time_range

🛍️ Product Management

get_products

Get list of products from Mayar with filtering by type, status, and search keywords.

get_products

get_product_detail

Get detailed product information by product ID / UUID.

get_product_detail

create_product

Create a new product (generic — type specific endpoints also available).

create_product

get_products_by_type

Get products filtered by a specific type (ebook, course, etc.).

get_products_by_type

update_product

Update an existing product by UUID.

update_product

act_on_product

Perform actions on a product: activate, close, delete, or duplicate.

act_on_product

get_product_transactions

Get all transactions associated with a specific product.

get_product_transactions

🔐 License Management

verify_license_code

Verify a license code for a digital product. Useful for SaaS/software licensing validation.

verify_license_code

💵 Payments / Request Payment

get_all_payments

Get a list of all request payments / payment links with filtering.

get_all_payments

get_payment_detail

Retrieve detailed payment information by UUID.

get_payment_detail

create_payment

Create a new request payment for a customer.

create_payment

update_payment

Update an existing request payment.

update_payment

act_on_payment

Perform actions on a payment: close, activate, or deactivate.

act_on_payment

sort_payment_links

Reorder / sort payment links by type with a custom product ID order.

sort_payment_links

🎟️ Coupons & Discounts

create_coupon

Create a new coupon / discount code for products.

create_coupon

validate_coupon

Validate a coupon during checkout (applies discount calculation).

validate_coupon

check_coupon

Check coupon availability and remaining usage.

check_coupon

get_coupon_detail

Retrieve detailed coupon/discount information by UUID.

get_coupon_detail

📅 Installments

get_all_installments

Get a list of all installment plans with filtering.

get_all_installments

get_installment_detail

Retrieve detailed installment plan with invoices breakdown.

get_installment_detail

create_installment

Create a new installment plan with tenure, interest, and invoices.

create_installment

📦 Bundling

get_bundling_list

Get a list of product bundles.

get_bundling_list

get_bundling_detail

Retrieve detailed bundle information by UUID.

get_bundling_detail

🔗 Webhooks

get_webhook_history

Get webhook delivery history with status filtering.

get_webhook_history

update_webhook_url

Update merchant webhook URL.

update_webhook_url

test_webhook

Send a test webhook event to the configured URL.

test_webhook

⭐ Reviews

get_product_reviews

Get reviews for a specific product / payment link.

get_product_reviews

get_product_review_stats

Get review statistics (ratings distribution) for a product.

get_product_review_stats

get_customer_review

Get the review left by a customer for a specific product.

get_customer_review

get_merchant_review_stats

Get overall review statistics for the merchant store.

get_merchant_review_stats

get_all_reviews

Get all reviews across all products with status filtering.

get_all_reviews

create_review

Create a new review for a transaction.

create_review

update_review

Update an existing review (rating, message, or status).

update_review

bulk_update_review_status

Bulk update review status for multiple reviews at once.

bulk_update_review_status

📱 QR Codes

create_qr_code

Create a dynamic QRIS code for a specific amount.

create_qr_code

get_qr_code

Retrieve the static QRIS code for the merchant.

get_qr_code

🔗 Webhooks

get_webhook_history

Get webhook delivery history with status filtering.

get_webhook_history

get_new_webhook_history

Get new webhook history from Scylla database with cursor pagination.

get_new_webhook_history

update_webhook_url

Update merchant webhook URL.

update_webhook_url

test_webhook

Send a test webhook event to the configured URL.

test_webhook

retry_webhook

Retry a failed webhook delivery by history ID.

retry_webhook

📊 Mayar MCP Server

What is MCP?

🖥️ MCP Client Integration

Connection Details

Environment Variables

🔑 Getting Your API Key