RevKeenDocs
StatusSupport
API Reference
🔗 CheckoutPayment Links

Archive a payment link

Permanently disable a payment link. This action cannot be undone. Equivalent to PATCH /v2/payment-links/{id}/status with status: "archived".

POST/payment-links/{id}/archive

Permanently disable a payment link. This action cannot be undone. Equivalent to PATCH /v2/payment-links/{id}/status with status: "archived".

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
  • PATCH /payment-links/{id}/status — Update payment link status
  • POST /payment-links/{id}/deactivate — Deactivate a payment link
  • POST /payment-links/{id}/activate — Activate a payment link

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.

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.

Formatuuid

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/payment-links/11111111-1111-4111-8111-111111111111/archive" \
  -H "x-api-key: $REVKEEN_API_KEY"

Synthetic documentation data, validated against the response schema; not a live API result.

{  "id": "00000000-0000-4000-8000-000000000001",  "status": "active",  "status_changed_at": "2026-09-01T12:00:00Z",  "is_active": true,  "updated_at": "2026-09-01T12:00:00Z"}

Put this endpoint to work

Integrate checkout