Api reference
Update payment link status
Change the status of a payment link. Active links accept payments, inactive links are temporarily disabled, and archived links are permanently disabled and cannot be reactivated.
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)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 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 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://api.revkeen.com/v2/payment-links/string/status" \ -H "x-api-key: $REVKEEN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "status": "active" }'{
"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"
}{
"error": "string",
"details": null
}Empty
{
"error": "string",
"details": null
}