Void a Payment

POST/api/payments/{identifier}/void

This endpoint voids a previously authorized payment before it has been captured. Voiding a payment cancels the transaction and prevents it from being processed.

Path Parameters

identifierstringrequired

Response

A successful response indicating the payment has been voided.

resultobject

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

Show result properties

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

The unique identifier for the merchant associated with the payment.

amountnumber<double>

The amount of the payment being voided.

currencyCodestring

The three-letter currency code (ISO 4217) for the voided payment.

paymentStatus"New" | "Authorized" | "Captured" | "Voided" | "Processing"

The current status of the payment after the void operation.

acquirerstring

The name of the acquirer processing the void.

customerIdentifierstring

The unique identifier for the customer associated with the payment.

customerReferencestring

A reference provided by the merchant to identify the customer.

merchantOrderIdstring

The unique identifier for the merchant's order.

paymentMethodIdentifierstring

The unique identifier for the payment method used.

paymentIdentifierstring

The unique identifier for the voided payment.

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

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.

Unauthorized request. Authentication is required.

Access is forbidden due to insufficient permissions.

The specified payment was not found.

resultobject

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

Show result properties

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.

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://testapi.linksmerchantservices.com/api/payments/<identifier>/void"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" ) func main() { req, _ := http.NewRequest("POST", "https://testapi.linksmerchantservices.com/api/payments/<identifier>/void", nil) resp, err := http.DefaultClient.Do(req) if err != nil { panic(err) } defer resp.Body.Close() data, _ := io.ReadAll(resp.Body) fmt.Println(string(data)) }

HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://testapi.linksmerchantservices.com/api/payments/<identifier>/void")) .method("POST", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); System.out.println(response.body());

require "net/http" require "uri" uri = URI("https://testapi.linksmerchantservices.com/api/payments/<identifier>/void") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) response = http.request(request) puts response.body

{ "result": { "resultType": "Accepted", "merchantMessage": "string", "logIdentifier": "string", "logAsError": true }, "merchantIdentifier": "string", "amount": 0, "currencyCode": "string", "paymentStatus": "New", "acquirer": "string", "customerIdentifier": "string", "customerReference": "string", "merchantOrderId": "string", "paymentMethodIdentifier": "string", "paymentIdentifier": "string" }