Home API Docs Webhooks SDKs
Sign In Get Started

API Documentation

Integrate OrionPay payment gateway into your application with our RESTful API.

🔐 Authentication

All API requests require an API key. Include it in the request header:

X-API-Key: your_api_key_here

⚠️ Get your API key from Merchant Dashboard → API Keys section after admin approval.

📝 Create Invoice

POST https://api.orionpay.com/v1/invoice/create

Request Headers

{
    "Content-Type": "application/json",
    "X-API-Key": "your_api_key_here"
}

Request Body

{
    "amount": 100.00,
    "pay_way": "cashapp",
    "customer_email": "customer@example.com",
    "customer_name": "John Doe",
    "redirect_url": "https://yoursite.com/success",
    "webhook_url": "https://yoursite.com/webhook"
}

Parameters

ParameterTypeRequiredDescription
amountnumeric✅ YesAmount to charge (min 1, max 10000)
pay_waystring✅ Yescashapp, ecashapp, applepay, googlepay, chime, btcpay, paypal, venmo
customer_emailstring❌ NoCustomer email address
customer_namestring❌ NoCustomer name
redirect_urlstring❌ NoRedirect after payment completion
webhook_urlstring❌ NoWebhook URL for payment status updates

Response (Auto Wallet - CashApp/Apple/Google/BtcPay)

{
    "success": true,
    "order_id": 123,
    "order_no": "API_123456_abc",
    "amount": 100.00,
    "pay_way": "cashapp",
    "payment_url": "https://pay.orionpay.com/xxx",
    "expires_at": "2026-01-15 12:00:00",
    "status": "processing"
}

Response (Manual Wallet - PayPal/Venmo/Chime)

{
    "success": true,
    "order_id": 123,
    "order_no": "API_123456_abc",
    "amount": 100.00,
    "pay_way": "paypal",
    "manual_code": "W6X-F1",
    "checkout_url": "https://orionpay.com/checkout/123",
    "status": "pending_manual",
    "message": "Send exactly $100.00 via paypal and use code: W6X-F1"
}

🔍 Check Order Status

GET https://api.orionpay.com/v1/invoice/status/{order_id}

Response

{
    "order_id": 123,
    "order_no": "API_123456_abc",
    "amount": 100.00,
    "real_amount": 100.00,
    "fee": 11.00,
    "net": 89.00,
    "pay_way": "cashapp",
    "status": "success",
    "created_at": "2026-01-15T10:00:00.000000Z",
    "success_time": "2026-01-15T10:05:00.000000Z",
    "expire_time": "2026-01-15T12:00:00.000000Z"
}

Status Values

pendingprocessingsuccessfailedclosedpending_manual

🔄 Webhooks

OrionPay sends POST requests to your webhook URL when payment status changes.

For BTCPay (CashApp, BtcPay)

{
    "type": "InvoiceSettled",
    "invoiceId": "xxx",
    "amount": 10.00,
    "currency": "USD"
}

For Third-party API (EcashApp, ApplePay, GooglePay)

{
    "mchOrderNo": "MCH_123456_abc",
    "state": 2,
    "amount": 10000,
    "realAmount": 10000
}

State values: 1=Pending, 2=Success, 3=Failed, 6=Closed

💳 Supported Wallets

cashapp ecashapp applepay googlepay chime btcpay paypal venmo

✅ All wallets are supported with automatic or manual settlement.

⚠️ Error Codes

CodeMessage
401API key required / Invalid API key
400Payment method not available
404Order not found
500Failed to create invoice / Internal server error

📦 SDKs & Libraries

PHP SDK
JavaScript SDK
Python SDK
Ruby SDK

Official SDKs available on GitHub. Contact support for custom integration.

Try it out

Get your API keys and start integrating in minutes.

Get API Keys →