PayOrc API Documentation
Explore PayOrc payment APIs, hosted checkout, server-to-server integrations, SDKs, webhooks, settlements, payouts, testing tools, and code examples.
Welcome to the PayOrc developer documentation. Use these guides and API references to design, test, and operate payment integrations through PayOrc's public interfaces.
Start Your Integration
Getting Started
Set up API credentials, understand the payment flow, and create your first test order.
Payment Request API
Create orders and payment requests using the PayOrc API.
Hosted Payment Page
Redirect customers to a PayOrc-hosted checkout and handle the final response.
Testing Tools
Validate integrations with test cards, API keys, and the Postman collection.
Integration Options
Choose the payment experience that matches your application and operational requirements:
- Hosted checkout for a PayOrc-hosted payment page and a straightforward redirect flow.
- Iframe checkout to embed the payment experience inside your application.
- Payment Request API to create orders and obtain payment links from your server.
- S2S integrations for approved server-to-server payment methods and transaction types.
- SDKs and plug-ins for mobile applications and supported commerce platforms.
- POS Web API for browser-connected point-of-sale order and payment flows.
Operate the Payment Lifecycle
Manage Payments
Capture, void, refund, upload invoice/AWB, fetch, and list payment orders.
Webhooks
Receive asynchronous transaction notifications and verify final payment status.
Settlements
Review settlement details, due amounts, pending balances, and webhook events.
Payouts
Create beneficiary transfers, check balances, and track payout status.
Developer Resources
- Review response codes for normalized API outcomes.
- Use ISO country codes in supported request fields.
- Download the Postman collection for repeatable API testing.
- Read the API key guide before sending authenticated requests.
Keep merchant credentials on your server. Never expose secret keys in browser code, mobile applications, public repositories, or client-visible logs.