Skip to main content
The Orafi API is organized around REST. It accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP status codes and verbs.

​
Base URL

Both test and live requests use the same base URL. Your API key determines the mode.

​
Authentication

Authenticate every request by including your API key in the x-api-key header:
See the Authentication guide for details on key formats and security best practices.

​
Request & response format

All request bodies must be application/json (except file uploads which use multipart/form-data). Every response follows a consistent envelope:

​
HTTP status codes

​
Rate limiting

API requests are rate-limited. Inspect these response headers to monitor your usage: If you hit the limit, back off and retry after X-RateLimit-Reset.

​
Pagination

List endpoints use cursor-based pagination for consistent performance: Response includes nextCursor and hasNextPage to indicate whether more data is available.

​
Explore endpoints

Payments

Create, verify, and retrieve payments.

Paylinks

Shareable no-code payment pages.

Transactions

Query your full transaction history.

Payouts

Withdraw funds to crypto or fiat.

Webhooks

Register endpoints and subscribe to events.

Customers

Manage customer records.