Api reference
Archive a payment link (deprecated)
Deprecated — use PATCH /v2/payment-links/{id}/status with status: "archived" instead. This convenience endpoint will be removed in a future API version. Permanently disable a payment link. This action cannot be undone.
Related endpoints
POST /payment-links— Create a new payment linkGET /payment-links— List payment linksGET /payment-links/{id}— Get payment link by IDPOST /payment-links/{id}/expire— Expire a payment link (deprecated)PATCH /payment-links/{id}/status— Update payment link statusPOST /payment-links/{id}/deactivate— Deactivate a payment link (deprecated)POST /payment-links/{id}/activate— Activate a payment link (deprecated)
Common errors
401 unauthenticated— missing, malformed, or revoked API key.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.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Payment link UUID or public_id
Length
1 <= lengthResponse Body
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/payment-links/string/archive" \ -H "x-api-key: $REVKEEN_API_KEY"{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "active",
"status_changed_at": "2019-08-24T14:15:22Z",
"is_active": true,
"updated_at": "2019-08-24T14:15:22Z"
}Empty
{
"error": "string",
"details": null
}