Developer platform

Connect order information to the rebate workflow.

Start with the API contract, identify the operations your server needs and understand how order changes are recorded. You can read these guides before requesting the reviewed credentials required for authenticated integration work.

Access model

Understand the integration before requesting access.

Review the API inventory to confirm that the documented order, refund and return operations fit your integration. The access request then identifies the company, commerce platform, expected request volume and technical owner needed to assess that connection.

Developer account required

Rebate Card X reviews the merchant, intended data flow and required scope before provisioning credentials. The developer access form starts that review; submitting it does not create an account or API key automatically.

API discovery

The base URL is a useful JSON entry point.

A public GET request identifies the API version and environment, then links to health, dependency status, OpenAPI and this documentation. No credential is needed for discovery.

Requestcurl

curl --request GET \
  --url https://api.rebatecardx.com/api/v1 \
  --header "Accept: application/json"

200 responseapplication/json

{
  "data": {
    "name": "Rebate Card X Platform API",
    "apiVersion": "v1",
    "contractVersion": "1.0.0",
    "environment": "production",
    "developerAccess": {
      "mode": "contact_required",
      "contactUrl": "https://www.rebatecardx.com/developers/access"
    },
    "links": {
      "self": "https://api.rebatecardx.com/api/v1",
      "documentation": "https://www.rebatecardx.com/developers",
      "apiReference": "https://www.rebatecardx.com/api-reference",
      "openapi": "https://api.rebatecardx.com/api/v1/openapi",
      "health": "https://api.rebatecardx.com/api/v1/health",
      "status": "https://api.rebatecardx.com/api/v1/status"
    }
  }
}

Documentation map

Find the guide for your next integration task.

01 / Access

Request an account

Prepare the business and technical context used during access review.

Access requirements
02 / Start

Run the quickstart

Discover the API, protect the credential and ingest a first idempotent order.

Quickstart guide
03 / Secure

Choose the right auth boundary

Separate public routes, server-side API keys and first-party session operations.

Authentication
04 / Integrate

Implement request mechanics

Use integer cents, UTC timestamps, idempotency keys, ETags and cursor pagination.

Requests and responses
05 / Diagnose

Handle errors safely

Branch on stable error codes and retain the request ID for support.

Error handling
06 / Subscribe

Verify signed events

Persist the raw body, validate the HMAC signature and deduplicate every delivery.

Webhook guide

Environments

Keep evaluation and live traffic separate.

EnvironmentBase URLPurpose
Staginghttps://staging-api.rebatecardx.com/api/v1Provisioned integration validation using staging credentials and non-production records.
Productionhttps://api.rebatecardx.com/api/v1Approved live merchant traffic using a separately provisioned production credential.

Credentials are environment-specific. Never send a staging key to the production host or copy live customer data into staging.

External integration surface

Distinguish external integration calls from portal operations.

The API reference includes several authentication modes. Use the boundary assigned to each operation rather than assuming a developer key authorizes every resource shown in the documentation.

Public discovery
API index, health, dependency status and OpenAPI are available without authentication.
Server-to-server writes
Tenant-scoped API keys currently authorize order ingestion, refunds and returns through the orders:write scope.
Merchant operations
Campaigns, awards, funding, reporting, API-key management and webhook configuration use authenticated first-party sessions.
Outbound events
Tenant lifecycle events are delivered to approved public HTTPS endpoints with an HMAC-SHA-256 signature and automatic retry.
Server-side only

Do not expose an rbx_ API key in browser JavaScript, a mobile application, a Shopify theme, source control, logs or client-visible configuration.

Contract principles

Predictable mechanics for sensitive operations.

Versioning

Explicit compatibility boundary

Platform endpoints live under /api/v1. Breaking contract changes require a new version boundary.

Idempotency

Safe mutation retries

API-key writes require an Idempotency-Key. Reusing a key with a different payload is rejected.

Concurrency

No silent overwrites

Versioned session resources return an ETag; updates require the current value in If-Match.

Data boundary

No raw card data

Requests containing PAN, CVV, PIN or track data are rejected. Send only the fields defined by the published contract.