RevKeenDocs
StatusSupport
API Reference

Expire a payment link (deprecated)

**Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "expired"` instead.** This convenience endpoint will be removed in a future API version. Mark a payment link as expired, preventing further use. --- **Related endpoints** - `POST /payment-links` — Create a new payment link - `GET /payment-links` — List payment links - `GET /payment-links/{id}` — Get payment link by ID - `PATCH /payment-links/{id}/status` — Update payment link status - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) **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. - `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).

Deprecated

POST
/payment-links/{id}/expire

Deprecated — use PATCH /v2/payment-links/{id}/status with status: "expired" instead. This convenience endpoint will be removed in a future API version. Mark a payment link as expired, preventing further use.

Related endpoints

  • POST /payment-links — Create a new payment link
  • GET /payment-links — List payment links
  • GET /payment-links/{id} — Get payment link by ID
  • PATCH /payment-links/{id}/status — Update payment link status
  • POST /payment-links/{id}/deactivate — Deactivate a payment link (deprecated)
  • POST /payment-links/{id}/activate — Activate a payment link (deprecated)
  • POST /payment-links/{id}/archive — Archive a payment link (deprecated)

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.
  • 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.

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

Path Parameters

id*string

Payment link UUID or public_id

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

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/payment-links/string/expire" \
  -H "x-api-key: $REVKEEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",  "public_id": "string",  "name": "string",  "slug": "string",  "mode": "invoice",  "status": "draft",  "amount_minor": 0,  "currency": "USD",  "invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",  "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",  "product_ids": [    "026d7765-cea5-4b36-a2c4-f616e464c692"  ],  "line_items": [    {      "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",      "price_id": "5eff5d89-979e-4e4f-aa76-6cbbbf11362c",      "quantity": 1,      "merchant_reference": "string",      "is_adhoc": true,      "product_details": {        "name": "string",        "description": "string",        "unit_amount": 0,        "currency": "string",        "recurring": {          "interval": "day",          "interval_count": 1        }      }    }  ],  "success_url": "http://example.com",  "cancel_url": "http://example.com",  "redirect_url": "http://example.com",  "collect_shipping": false,  "allow_promotion_codes": true,  "tax_behavior": "exclusive",  "metadata": {    "property1": null,    "property2": null  },  "expires_at": "2019-08-24T14:15:22Z",  "selection_mode": "bundle",  "default_product_id": "c121a2c4-c1b3-42a7-a0b4-a4d664ac7263",  "highlighted_product_id": "284a4c39-e955-434f-9f8c-f2d2b65f458a",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Deactivate a payment link (deprecated) POST

**Deprecated — use `PATCH /v2/payment-links/{id}/status` with `status: "inactive"` instead.** This convenience endpoint will be removed in a future API version. Temporarily disable a payment link. It can be reactivated later. --- **Related endpoints** - `POST /payment-links` — Create a new payment link - `GET /payment-links` — List payment links - `GET /payment-links/{id}` — Get payment link by ID - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) - `PATCH /payment-links/{id}/status` — Update payment link status - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) **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. - `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).

Get payment link by ID GET

Retrieve a payment link by its UUID or public_id --- **Related endpoints** - `POST /payment-links` — Create a new payment link - `GET /payment-links` — List payment links - `POST /payment-links/{id}/expire` — Expire a payment link (deprecated) - `PATCH /payment-links/{id}/status` — Update payment link status - `POST /payment-links/{id}/deactivate` — Deactivate a payment link (deprecated) - `POST /payment-links/{id}/activate` — Activate a payment link (deprecated) - `POST /payment-links/{id}/archive` — Archive a payment link (deprecated) **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.