Welcome to Royat Pay
Complete API Documentation and Integration Guide
Get Started with Royat Pay
Integrate seamless payment processing into your application with our comprehensive API documentation. Support for multiple payment methods including cards, Apple Pay, Google Pay, and more.
🚀 Quick Start
Get up and running with Royat Pay in minutes:
- Obtain your API token from your client dashboard
- Authenticate using Bearer token in request headers
- Start making payment requests using our RESTful API
- Handle callbacks and webhooks for payment status updates
API Endpoints
📱 Embedded Integration
Integrate payment forms directly into your website with our embedded payment solution. Supports Card, Apple Pay, Google Pay, and STC Pay.
View Documentation →💳 Initiate Payment
Retrieve all available payment methods with service charges. Get payment method IDs and details before executing a payment.
View Documentation →⚡ Execute Payment
Create and execute payment transactions. Supports both embedded payment sessions and redirect checkout integration.
View Documentation →📋 Payment Status
Check payment status by PaymentId. Verify transactions after callback or embedded payment — know if a payment is Paid, Pending, or Canceled.
View Documentation →🔄 Make Refund
Process refunds for completed payments. Support for full and partial refunds with flexible service charge handling.
View Documentation →🔎 Session Details
Verify the status and PaymentId of an embedded (v3 session) payment when a callback doesn't surface one.
View Documentation →🔗 Payment Links
Create a shareable payment link and invoice from your own platform, with an optional SMS/email notification.
View Documentation →🍏 Apple Pay Domain
Self-register your checkout domain for Apple Pay after publishing the domain association file.
View Documentation →💰 Live Balance
Read your pending, deposited, and total balance in real time, without waiting for a report.
View Documentation →🧾 Deposit History
List your settlement deposits with pagination and sorting — build your own reconciliation view.
View Documentation →Laravel SDK
Use the official Royat Pay Laravel SDK to create payments, check status, request refunds, and read supplier invoices from Laravel stores.
View Documentation →WooCommerce Plugin
Install Royat Pay as a WooCommerce payment method with embedded checkout and Royat-branded settings.
View Documentation →WHMCS Gateway
Install Royat Pay as a WHMCS payment gateway for hosting, billing, and subscription invoices.
View Documentation →Authentication
All API requests require authentication using a Bearer token.
Include your client token in the Authorization header:
Authorization: Bearer {your_client_token}Your client token is unique to your account and can be found in your client dashboard.
Base URL
All API endpoints are available at:
https://panel.royat.sa/apiFor example:
https://panel.royat.sa/api/payment/initiateResponse Format
All API responses follow a consistent format:
{
"IsSuccess": true,
"Message": "Operation completed successfully",
"ValidationErrors": null,
"Data": {
// Response data here
}
}Error Handling
Error responses will include:
IsSuccess: false- Indicates the request failedMessage- Human-readable error messageValidationErrors- Object containing field-specific errors
Support
Need help? Contact our support team for assistance with integration, troubleshooting, or any questions about our API.