Set Payment Link Archived
PATCH
https://api.apicenter.itsandbox.site/api/v1/payments/payment-links/{paymentLinkId}Perform Set Payment Link Archived operation on APICenter platform.
const paymentApiKey = process.env.APICENTER_PAYMENT_API_KEY;
if (!paymentApiKey) throw new Error("APICENTER_PAYMENT_API_KEY is required");
const requestBody = {} /* Fill the documented request fields. */;
const response = await fetch("https://api.apicenter.itsandbox.site/api/v1/payments/payment-links/{paymentLinkId}", {
method: "PATCH",
headers: {
Authorization: "Bearer " + paymentApiKey,
"Idempotency-Key": "unique-key-setPaymentLinkArchived",
"Content-Type": "application/json"
},
body: JSON.stringify(requestBody)
});
if (!response.ok) throw new Error("APICenter request failed: " + response.status);
const data = await response.json();
console.log(data);Response
No response example is supplied by this contract. See the documented response schema.Authentication
AuthorizationAPICenterApiKey
Authorization: Bearer <PAYMENT_API_KEY>. Use the consumer's payment API key. or Registered APICenter service JWT with gateway-enforced scopes.
Headers
Unique key for safely retrying this payment mutation. Reuse the same key and request body after uncertain outcomes. A key used with a different request, an in-progress request, or an unresolved provider outcome returns HTTP 409.
Request Body
Response
200Payment link archive state updated
Errors
404Resource not found
409The key was used with a different request, is already processing, or the provider outcome remains unresolved. Inspect `error.code`; in particular, `PAYMENT_OUTCOME_UNKNOWN` requires reconciliation before using a new key.