Overview
Get started with the Relograde API
Welcome
The Relograde API enables you to integrate Relograde's payment infrastructure directly into your platform. Our documentation is also available as an OpenAPI spec:
Relograde API
View the OpenAPI specification
Environments
The Relograde API has two environments:
| Environment | Description |
|---|---|
| Production | Requires a verified account. Uses real money. |
| Sandbox | Available to unverified accounts. Mirrors production behavior but does not use real money. |
Prices may be different in the sandbox environment for unverified accounts.
Authentication
The API uses Bearer token authentication. Include your API key in every request:
Authorization: Bearer <your-api-key>Obtaining API Keys
Same paths across environments
Both Sandbox and Production use identical API paths. Only the API key differs.
IP Whitelist
Restrict API access to specific IP addresses. Supported formats:
| Format | Example |
|---|---|
| Single IP | 192.168.1.1 |
| Multiple IPs | 192.168.1.1, 192.168.1.2 |
| CIDR Range | 192.168.1.0/24 |
Whitelist behaviour
- Leave the field empty to permit access from any IP address.
- Only IPv4 addresses are supported.
- Use commas to separate multiple entries.
URL
Relograde API urls adhere to the following structure:
{BASE_URL}/api/{VERSION}/{RESOURCE}
| Base URL | https://connect.relograde.com |
| Current version | 1.03 |
Examples:
https://connect.relograde.com/api/1.03/account
https://connect.relograde.com/api/1.03/brand
https://connect.relograde.com/api/1.03/order
https://connect.relograde.com/api/1.03/productRate Limits
| Environment | Requests per minute |
|---|---|
| Sandbox | 60 |
| Production | 60 |
Rate limit exceeded
Requests that exceed the limit will receive a 429 rate_limit_exceeded response. Implement exponential backoff before retrying.
Error Handling
| Status | Code | Description |
|---|---|---|
400 | bad_request | The request was malformed or missing required fields |
401 | unauthorized | Missing or invalid API key |
402 | payment_required | Insufficient account balance |
403 | forbidden | Request origin is not whitelisted |
404 | not_found | The requested resource does not exist |
429 | rate_limit_exceeded | Too many requests, slow down and retry |
500 | server_error | An unexpected error occurred on our side |