Create a new payment link
Create a new payment link for invoices, subscriptions, or custom amounts --- **Related endpoints** - `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}/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. - `409 conflict` — Idempotency-Key collision with a different body, or a concurrent state-transition conflict. **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).
Create a new payment link for invoices, subscriptions, or custom amounts
Related endpoints
GET /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)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 aWWW-Authenticate: Bearerchallenge.409 conflict— Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
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.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.revkeen.com/v2/payment-links" \
-H "x-api-key: $REVKEEN_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"product_ids": [
"00000000-0000-0000-0000-000000000000"
],
"line_items": [
{
"price": "00000000-0000-0000-0000-000000000000",
"price_data": {
"currency": "USD",
"unit_amount": 0,
"product_data": {
"name": null,
"description": null,
"images": null,
"metadata": null
},
"product": "00000000-0000-0000-0000-000000000000",
"recurring": null,
"tax_behavior": "inclusive"
},
"quantity": 1,
"merchant_reference": null
}
],
"name": "string",
"slug": "string",
"mode": "custom",
"amount_minor": 0,
"currency": "USD",
"invoice_id": "00000000-0000-0000-0000-000000000000",
"subscription_id": "00000000-0000-0000-0000-000000000000",
"success_url": "https://example.com",
"cancel_url": "https://example.com",
"redirect_url": "https://example.com",
"collect_shipping": false,
"allow_promotion_codes": true,
"tax_behavior": "unspecified",
"metadata": {},
"expires_at": "2026-01-01T00:00:00Z",
"selection_mode": "bundle",
"default_product_id": null,
"highlighted_product_id": null,
"idempotency_key": "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"}Archive a payment link (deprecated) POST
**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 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}/deactivate` — Deactivate a payment link (deprecated) - `POST /payment-links/{id}/activate` — Activate 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. **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).
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).