Skip to navigation
TIANKII API - API KeyPayment RequestsGeneral Operations

Delete payment request

View as Markdown

Delete payment request

Permanently deletes the payment request :id. The request must belong to the store resolved from the API key (validated before deletion). Returns a uniform mutation confirmation ({ success, message }) rather than the entity.

Authentication

Send the merchant API key in x-api-key. Requires scope Merchant.payment_link.delete. Optionally scope with x-application-account-id.

Path parameters

  • id — payment request id.

There is no request body.

Notas: Handler: lifecycleService.remove. Returns MutationResponseDto ({ success, message }). Accepts deprecated aliases DELETE /v1/payment-links/:id and DELETE /v1/payment-link/:id.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
Id of the payment request to delete.

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.