MyroPay API Reference

# Checkout API (SDK-facing — auth via checkout key)
https://checkout.myropay.com/api/

# Business API (auth via JWT or business key)
https://business.myropay.com/api/

# Personal App API (auth via JWT)
https://app.myropay.com/api/

X-Checkout-Key: ck_sec_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEsImFjdG9yX3R5cGUiOiJidXNpbmVzcyJ9.xxx

{
  "success": true,
  "message": "Session created",
  "data": { /* response payload */ }
}

{
  "success": false,
  "message": "amount must be greater than 0",
  "error_code": "VALIDATION_ERROR",
  "status_code": 422
}

GET /api/invoices.php?action=list&page=2&per_page=20

{
  "success": true,
  "data": {
    "data":         [ /* array of items */ ],
    "total":        143,
    "page":         2,
    "per_page":     20,
    "total_pages":  8,
    "has_next":     true,
    "has_prev":     true
  }
}

{
  "amount":          5000,
  "currency_code":   "NGN",
  "idempotency_key": "order_9876_attempt_1"
}

import MyroPay from 'myropay-js';

app.post('/webhook', express.raw({type:'application/json'}), (req, res) => {
  const sig    = req.headers['x-myropay-signature'];
  const secret = 'ck_wh_your_secret';
  if (!await MyroPay.verifyWebhook(req.body, sig, secret)) {
    return res.status(401).send('Unauthorized');
  }
  const event = JSON.parse(req.body);
  switch(event.event) {
    case 'checkout.completed': fulfillOrder(event.data); break;
  }
  res.json({ received: true });
});

$payload = file_get_contents('php://input');
$sig     = $_SERVER['HTTP_X_MYROPAY_SIGNATURE'] ?? '';
$secret  = 'ck_wh_your_secret';
$expected= hash_hmac('sha256', $payload, $secret);

if (!hash_equals($expected, $sig)) {
  http_response_code(401); exit;
}
$event = json_decode($payload, true);
if ($event['event'] === 'checkout.completed') {
  fulfillOrder($event['data']);
}

import hmac, hashlib

@app.route('/webhook', methods=['POST'])
def webhook():
    payload   = request.get_data()
    sig       = request.headers.get('X-MyroPay-Signature', '')
    secret    = b'ck_wh_your_secret'
    expected  = hmac.new(secret, payload, hashlib.sha256).hexdigest()
    if not hmac.compare_digest(expected, sig):
        return 'Unauthorized', 401
    event = request.get_json()
    if event['event'] == 'checkout.completed':
        fulfill_order(event['data'])
    return '', 200

import MyroPay from 'myropay-js';
const client = new MyroPay('ck_sec_live_xxxx');

const session = await client.checkout.create({
  amount:         500000,   // ₦5,000.00 in kobo
  currency_code:  'NGN',
  description:    'Order #1234',
  customer_email: 'customer@example.com',
  success_url:    'https://mystore.com/success',
  cancel_url:     'https://mystore.com/cancel',
  metadata:       { order_id: 'ORD-9876' },
  idempotency_key: 'order-9876-attempt-1',
});

// Redirect customer to payment page
window.location.href = session.checkout_url;

use MyroPay\Client;
$client = new Client('ck_sec_live_xxxx');

$session = $client->checkout->create([
  'amount'          => 500000,
  'currency_code'   => 'NGN',
  'description'     => 'Order #1234',
  'customer_email'  => 'customer@example.com',
  'success_url'     => 'https://mystore.com/success',
  'cancel_url'      => 'https://mystore.com/cancel',
  'metadata'        => ['order_id' => 'ORD-9876'],
  'idempotency_key' => 'order-9876-attempt-1',
]);

header('Location: ' . $session['checkout_url']);

import myropay
client = myropay.Client("ck_sec_live_xxxx")

session = client.checkout.create(
    amount=500000,
    currency_code="NGN",
    description="Order #1234",
    customer_email="customer@example.com",
    success_url="https://mystore.com/success",
    cancel_url="https://mystore.com/cancel",
    metadata={"order_id": "ORD-9876"},
    idempotency_key="order-9876-attempt-1",
)
return redirect(session["checkout_url"])

curl -X POST https://checkout.myropay.com/api/session.php?action=create \
  -H "X-Checkout-Key: ck_sec_live_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 500000,
    "currency_code": "NGN",
    "description": "Order #1234",
    "customer_email": "customer@example.com",
    "success_url": "https://mystore.com/success",
    "cancel_url": "https://mystore.com/cancel",
    "metadata": { "order_id": "ORD-9876" },
    "idempotency_key": "order-9876-attempt-1"
  }'

{ "token": "a1b2c3d4..." }

{ "id": 42 }

{
  "event":     "checkout.completed",
  "app_id":   7,
  "timestamp":1714123456,
  "data": {
    "session": {
      "id":             42,
      "session_token":  "a1b2c3d4...",
      "amount":        500000,
      "currency_code": "NGN",
      "customer_email":"customer@example.com",
      "customer_name": "John Doe",
      "status":        "completed",
      "paid_at":       "2025-01-15 12:34:56",
      "metadata":      { "order_id": "ORD-9876" }
    }
  }
}

{
  "event": "transfer.completed",
  "data": {
    "reference":  "MPY-20250115-ABCD1234",
    "amount":     10000,
    "currency":   "NGN",
    "status":     "SUCCESSFUL",
    "bank_name":  "First Bank",
    "account":    "****1234"
  }
}

{
  "event": "invoice.paid",
  "data": {
    "invoice_number": "INV-2025-0042",
    "client_email":   "client@company.com",
    "amount":         250000,
    "currency_code":  "NGN",
    "paid_at":        "2025-01-15 14:20:00"
  }
}

{
  "event": "payroll.completed",
  "data": {
    "batch_id":        12,
    "batch_name":      "January 2025 Salary",
    "recipient_count": 24,
    "total_amount":    "4800000.00",
    "currency_code":  "NGN",
    "completed_at":   "2025-01-31 14:00:00"
  }
}