# Readme

English | [简体中文](https://docs.mugglepay.com/readme-1)

## Overview

Welcome to MugglePay! A comprehensive cryptocurrency payment solution that enables merchants to accept crypto payments with minimal integration effort.

## Quick Start

Get started with MugglePay API in minutes. Follow our [Getting Started Guide](https://docs.mugglepay.com/faq/getstarted) to begin building your integration.

<div align="center"><img src="https://dcdn.mugglepay.com/dt/pay/docs/mp-create.png" alt="Create Order Flow" width="400"></div>

## Merchant Portal

Access your developer API key and manage crypto orders through the [Merchant Portal](https://merchants.mugglepay.com/).

<div align="center"><img src="https://dcdn.mugglepay.com/dt/pay/docs/mp-login.png" alt="Merchant Login" width="250"></div>

## API Reference

<figure><img src="https://730606727-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FH72DzrQFwTyeqWzBL0Qf%2Fuploads%2Ff3bk3iZsjSDXVafHh0HB%2Fmugglepayintegration.png?alt=media&#x26;token=fa62fb89-e46c-4e9b-9ee5-3e61a54eb409" alt="" width="375"><figcaption></figcaption></figure>

### Core Concepts

* [Getting Started](https://docs.mugglepay.com/faq/getstarted) - Quick integration guide
* [API Overview](https://docs.mugglepay.com/faq/overview) - Understanding MugglePay architecture
* [Order Status](https://docs.mugglepay.com/basic/orderstatus) - Payment status definitions
* [Error Codes](https://docs.mugglepay.com/basic/errorcodes) - Common error handling
* [Authentication](https://docs.mugglepay.com/basic/authentication) - API security and tokens

### Payment Operations

* [Create Order](https://docs.mugglepay.com/order/createorder) - Initialize payment requests
* [Payment Callback](https://docs.mugglepay.com/order/paymentcallback) - Webhook notifications
* [Get Order](https://docs.mugglepay.com/order/getorder) - Retrieve order details
* [Get Orders](https://docs.mugglepay.com/order/getorders) - List all orders
* [Checkout Order](https://docs.mugglepay.com/order/checkoutorder) - Select payment currency
* [Cancel Order](https://docs.mugglepay.com/order/cancelorder) - Cancel pending orders
* [Refund](https://docs.mugglepay.com/order/refund) - Process refunds

### Support & Resources

* [Customer FAQ](https://docs.mugglepay.com/faq/customerfaq) - Common user questions
* [Merchant FAQ](https://docs.mugglepay.com/faq/merchantfaq) - Integration troubleshooting
* [Self-Managed Solutions](https://docs.mugglepay.com/self-managed-non-custodian) - Advanced deployment options

<div align="center"><img src="https://dcdn.mugglepay.com/dt/pay/docs/mp-payment.png" alt="Payment Flow" width="250"></div>

## Next Steps

1. **Read the** [**Getting Started Guide**](https://docs.mugglepay.com/faq/getstarted) to understand the integration flow
2. **Set up your** [**Merchant Account**](https://merchants.mugglepay.com/) to get your API keys
3. **Review** [**Authentication**](https://docs.mugglepay.com/basic/authentication) to secure your API calls
4. **Test with** [**Create Order**](https://docs.mugglepay.com/order/createorder) to build your first payment flow

## License

[BSD](https://www.wikiwand.com/en/BSD_licenses) Copyright (c) 2018-present, Muggles. All rights reserved.