Integration
Integration Guide
Prerequisites
API Keys
Supported Blockchains
Get Active Blockchains
Base URL
Rate Limits
Authentication
Request Headers
The Canonical String
Worked Example
Code Samples
Node.js / TypeScript
curl / bash
Common Failure Modes
Key Rotation
External Payments API
The Payment Object
Create a Payment Prompt
US Merchant Accounts
Idempotency
Retrieve a Payment
List Payments
Get Active Blockchains
Errors
End-to-End Example
Best Practices
Allowed Redirect Domains
Redirect to Checkout
Checkout URL Structure
Redirect Methods
Server-Side Redirect (Recommended)
Client-Side Redirect
Checkout Flow
Post-Payment Handling
Automatic Redirect (Recommended)
Manual Polling (Without Redirect URL)
Payment Expiration
Checking Payment Status
Webhooks vs Polling
Payment Status Values
Polling for Status
Polling Implementation
Node.js / TypeScript
Python
Background Job Pattern
Status Transition Diagram
Best Practices
Webhooks
Setup
Event Types
Event Envelope
Delivery Headers
Verifying Signatures
Delivery and Retries
Best Practices
Quick Start
Reference
Error Reference
Error Envelope
Response Headers
Error Types
Error Codes
Validation Errors (E1xxx)
invalid_request (E1000)
parameter_invalid (E1001)
parameter_unknown (E1002)
redirect_domains_not_configured (E1010)
redirect_url_invalid (E1011)
redirect_domain_not_allowed (E1012)
blockchain_not_configured (E1020)
merchant_not_configured (E1030)
conflict (E1040)
Authentication and Permission Errors (E2xxx)
authentication_required (E2001)
timestamp_invalid (E2002)
timestamp_expired (E2003)
api_key_invalid (E2004)
api_key_revoked (E2005)
api_key_expired (E2006)
signature_invalid (E2007)
merchant_disabled (E2008)
api_signature_replayed (E2009)
insufficient_scope (E2101)
merchant_onboarding_incomplete (E2102)
Resource Errors (E3xxx)
resource_missing (E3001)
Idempotency Errors (E4xxx)
idempotency_key_invalid (E4001)
idempotency_params_mismatch (E4002)
idempotency_in_progress (E4003)
Internal Errors (E5xxx)
internal_error (E5001)
service_unavailable (E5002)
Rate Limiting (E9xxx)
rate_limited (E9001)
User
Miracle Pay User Manual
What is Miracle Pay?
Registration
Google Authentication
KYB Verification
Branch Creation
Creating a Sale
Developer Settings
MiraclePayV2
Index
Index