Skip to navigation
TIANKII API - API KeyPayment RequestsGeneral Operations

Archive payment request

View as Markdown

Archive/unarchive payment request

Sets the Archived flag of payment request :id according to the boolean :value path segment (true archives, false unarchives). Archiving does not change the request status; it only toggles the Archived field. The request must belong to the store resolved from the API key.

Authentication

Send the merchant API key in x-api-key. Requires scope Merchant.payment_link.update.

Path parameters

  • id — payment request id.
  • value — boolean (true/false), parsed by ParseBoolPipe.

There is no request body. Returns the updated payment request shaped by its type.

Notas: Handler: lifecycleService.archive -> update({ Archived: value }). Accepts deprecated aliases PATCH /v1/payment-links/:id/archive/:value and PATCH /v1/payment-link/:id/archived/:value.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired

Id of the payment request to archive/unarchive.

valuestringRequired

true archives, false unarchives. Parsed by ParseBoolPipe (accepts true/false).

Headers

x-application-account-idstringOptional

Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.