Links API DocsLinks API Docs

Delete a Payment Method

POST/api/paymentmethod/delete/{identifier}

This endpoint deletes a payment method identified by its unique identifier. Upon successful deletion, a confirmation response is returned.

Path Parameters

identifierstringrequired

Response

A successful response confirming the deletion of the payment method.

resultobject

The result of the request, including status and any relevant messages.

Show result properties
resultType"Accepted" | "Declined" | "NotFound" | "ValidationFailed" | "Forbidden" | "Error"

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.

merchantIdentifierstring

A unique identifier for the merchant associated with this payment method.

customerIdentifierstring

A unique identifier for the customer associated with this payment method, if applicable.

customerReferencestring

An optional reference provided by the merchant to identify the customer.

paymentMethodIdentifierstring

A unique identifier for the payment method.

The request is invalid or contains incorrect parameters.

resultobject

The result object that contains the outcome and additional details of the API request.

Show result properties
resultType"Accepted" | "Declined" | "NotFound" | "ValidationFailed" | "Forbidden" | "Error"

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.

The specified payment method was not found.

resultobject

The result object that contains the outcome and additional details of the API request.

Show result properties
resultType"Accepted" | "Declined" | "NotFound" | "ValidationFailed" | "Forbidden" | "Error"

The type of result indicating the status of the request.

merchantMessagestring

A message intended for the merchant, providing additional details about the result of the request.

logIdentifierstring

A unique identifier for the server log entry related to this request, useful for troubleshooting.

logAsErrorboolean

Indicates whether this log entry should be treated as an error.

Request
curl -X POST "https://testapi.linksmerchantservices.com/api/paymentmethod/delete/<identifier>"
Response
{
  "result": {
    "resultType": "Accepted",
    "merchantMessage": "string",
    "logIdentifier": "string",
    "logAsError": true
  },
  "merchantIdentifier": "string",
  "customerIdentifier": "string",
  "customerReference": "string",
  "paymentMethodIdentifier": "string"
}