RevKeenDocs
StatusSupport
API Reference

Create a discount

Create a new discount code. --- **Related endpoints** - `GET /discounts` — List discounts - `GET /discounts/{id}` — Get discount by ID - `PATCH /discounts/{id}` — Update a discount - `DELETE /discounts/{id}` — Delete a discount **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

POST
/discounts

Create a new discount code.

Related endpoints

  • GET /discounts — List discounts
  • GET /discounts/{id} — Get discount by ID
  • PATCH /discounts/{id} — Update a discount
  • DELETE /discounts/{id} — Delete a discount

Common errors

  • 400 invalid_request — malformed payload or failed validation.
  • 401 authentication_error — missing, invalid, expired, or revoked credential. Codes: authentication_failed, invalid_api_key, expired_api_key, api_key_revoked, session_invalid, merchant_required. Carries a WWW-Authenticate: Bearer challenge.

Idempotency

Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.

Authorization

x-api-key<token>

Your RevKeen merchant API key. Create and manage keys in Dashboard → Settings → Developer. Use rk_sandbox_* for staging/test and rk_live_* for production. The same key may be sent as Authorization: Bearer <key> if that suits your HTTP client better. A missing, invalid, expired, or revoked key returns 401 with a WWW-Authenticate: Bearer challenge; a valid key without the required scope returns 403.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Parameters for creating a new discount code with amount, type, and usage limits.

Response Body

application/json

application/json

application/json

application/json

Stuck on an error response? Ask the RevKeen assistant to explain it.
curl -X POST "https://api.revkeen.com/v2/discounts" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "SUMMER20",
    "name": "Summer Sale 20% Off",
    "description": "20% off for summer promotion",
    "discount_type": "percentage",
    "discount_value": 20,
    "applies_to": "all",
    "scope": "entire_order",
    "product_ids": [
      "string"
    ],
    "max_redemptions": 100,
    "max_redemptions_per_user": 1,
    "valid_from": "2024-06-01T00:00:00Z",
    "valid_until": "2024-08-31T23:59:59Z",
    "recurring_type": "once",
    "recurring_cycles": 3,
    "first_time_customer": false
  }'
{  "data": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "code": "string",    "name": "string",    "description": "string",    "discount_type": "string",    "discount_value": 0,    "applies_to": "string",    "product_ids": [      "string"    ],    "max_redemptions": 0,    "current_redemptions": 0,    "valid_from": "string",    "valid_until": "string",    "recurring_type": "string",    "recurring_cycles": 0,    "first_time_customer": true,    "is_active": true,    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z"  }}

Validate a UK bank account for Direct Debit POST

Validates UK bank account details (sort code + account number) for Direct Debit eligibility with the bureau. --- **Related endpoints** - `GET /dd/mandate-requests/{token}` — Look up a pending signed mandate request - `POST /dd/preview` — Preview the Direct Debit collection date chain **Common errors** - `400 invalid_request` — malformed payload or failed validation. - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).

Delete a discount DELETE

Archive a discount (soft delete). The discount code can no longer be used. --- **Related endpoints** - `GET /discounts` — List discounts - `POST /discounts` — Create a discount - `GET /discounts/{id}` — Get discount by ID - `PATCH /discounts/{id}` — Update a discount **Common errors** - `401 authentication_error` — missing, invalid, expired, or revoked credential. Codes: `authentication_failed`, `invalid_api_key`, `expired_api_key`, `api_key_revoked`, `session_invalid`, `merchant_required`. Carries a `WWW-Authenticate: Bearer` challenge. - `404 resource_missing` — the referenced resource does not exist or is not visible to your key. **Idempotency** Pass an `Idempotency-Key` header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see [the idempotency guide](/docs/fundamentals/idempotency).