Skip to main content
DELETE
/
payment-link
/
delete
/
{id}
Soft delete a payment link record
curl --request DELETE \
  --url https://sandbox.omnispay.com/api/payment-link/delete/{id} \
  --header 'X-HMAC-Signature: <api-key>' \
  --header 'accountId: <api-key>' \
  --header 'apiKey: <api-key>'
{
  "status": "<string>",
  "message": "<string>",
  "response": {}
}

​
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

PUT /payment-link/delete/1234567890
User-Agent: Mozilla/5.0

Authorizations

​
apiKey
string
header
required
​
X-HMAC-Signature
string
header
required
​
accountId
string
header
required

Headers

​
User-Agent
string

Path Parameters

​
id
string
required

Order ID for retrieving the payment link record

Response

OK. Payment link record deleted successfully

​
status
string
​
message
string
​
response
object