> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnispay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete Payment Link

> This DELETE API is used to process a soft delete of a payment link record from the database.

# Soft Delete Payment Link

This endpoint allows merchants to perform a **soft delete** on a payment link record in the database. A soft delete means that the record is not permanently removed but is marked as inactive.

## Path Parameters

* **id** (string, required):\
  The unique identifier (Order ID) of the payment link record to be deleted.
  * Example: `1234567890`
  * The API will update the status of the specified payment link record to indicate that it is deleted.

📌 **How it Works**\
If a valid `id` is provided, the API will update the record's status instead of permanently removing it. The record remains in the database but is no longer considered active.

## Request Headers

* **User-Agent** (string, optional): The User-Agent header, which is not mandatory.

## Example Request

```http theme={null}
PUT /payment-link/delete/1234567890
User-Agent: Mozilla/5.0
```


## OpenAPI

````yaml DELETE /payment-link/delete/{id}
openapi: 3.0.1
info:
  title: OP APIs
  description: OP APIs
  version: 1.0.0
  license:
    name: MIT
servers:
  - url: https://sandbox.omnispay.com/api/
    description: Sandbox server for testing and integration without affecting live data
security:
  - apiKey: []
    hmacSignature: []
    accountId: []
paths:
  /payment-link/delete/{id}:
    delete:
      tags:
        - Public API for Payment Link Operations
      summary: Soft delete a payment link record
      description: >-
        This DELETE API is used to process a soft delete of a payment link
        record from the database.
      operationId: deletePaymentLinkRecord
      parameters:
        - name: User-Agent
          in: header
          required: false
          schema:
            type: string
        - name: id
          in: path
          description: Order ID for retrieving the payment link record
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK. Payment link record deleted successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '400':
          description: Bad Request. Invalid payment link ID or input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '401':
          description: >-
            Unauthorized. Access is denied due to invalid credentials or missing
            authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '403':
          description: Forbidden. You do not have permission to perform this action
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '404':
          description: >-
            Not Found. The payment link record with the specified ID does not
            exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '409':
          description: >-
            Conflict. The payment link record could not be deleted due to a
            conflict with the current state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '429':
          description: >-
            Too Many Requests. The user has exceeded the allowed number of
            requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '500':
          description: >-
            Internal Server Error. An unexpected error occurred while processing
            the request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
components:
  schemas:
    CommonResponse:
      type: object
      properties:
        status:
          type: string
        message:
          type: string
        response:
          type: object
  securitySchemes:
    apiKey:
      type: apiKey
      name: apiKey
      in: header
    hmacSignature:
      type: apiKey
      name: X-HMAC-Signature
      in: header
    accountId:
      type: apiKey
      name: accountId
      in: header

````