Introduction

Base URL

The Orcuspay API is built on REST principles. All communication is over HTTPS.

https://brain.orcuspay.com/api/v1

Authentication

Every request must include your API key and secret, available from your Orcuspay dashboard. Include them as request headers:

x-api-key:    <your-access-key>
x-api-secret: <your-secret-key>

Or use Bearer authentication:

Authorization: Bearer <access-key>:<secret-key>

Your keys are prefixed with the mode they belong to — keys starting with ak_prod_ / sk_prod_ are for live payments, and ak_test_ / sk_test_ are for test mode. Never expose your secret key in client-side code.

Response Format

Successful responses are wrapped in a data field:

{
  "data": { ... }
}

List endpoints include pagination metadata:

{
  "data": [ ... ],
  "meta": {
    "has_more": true,
    "next_cursor": "pay_..."
  }
}

Errors return a JSON body with an error object:

{
  "error": {
    "code": "invalid_request",
    "message": "title is required",
    "status": 400
  }
}

Response Codes

Code	Meaning
`200`	Success
`201`	Resource created
`400`	Bad request — missing or invalid parameters
`401`	Unauthorized — invalid or missing API credentials
`404`	Not found
`405`	Method not allowed
`500`	Internal server error

Rate Limiting

You can make up to 50 requests per second. Exceeding this limit may result in temporary restrictions.

Test Mode

Use your ak_test_ / sk_test_ keys to make requests in test mode. Test payments and payment links are fully isolated from live data.

API Reference

Checkout Sessions

Native Checkout

Payments

Payment Links

Introduction

Base URL

Authentication

Response Format

Response Codes

Rate Limiting

Test Mode

​Base URL

​Authentication

​Response Format

​Response Codes

​Rate Limiting

​Test Mode

Base URL

Authentication

Response Format

Response Codes

Rate Limiting

Test Mode