Refund a Payment

POST/api/payments/{identifier}/refund

This endpoint refunds a previously captured payment by providing the necessary refund details, including the amount to be refunded.

Path Parameters

identifierstringrequired

Body application/json

refundedAlreadyAtProcessorboolean

Indicates if the refund has already been processed by the payment processor.

amountnumber<double>

The amount to be refunded.

Response

A successful response indicating the payment was refunded.

resultobject

The result of the refund 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 refunded amount.

currencyCodestring

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

acquirerstring

The name of the acquirer processing the refund.

customerIdentifierstring

The unique identifier for the customer associated with the refund.

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 for the refund.

paymentIdentifierstring

The unique identifier for the refunded 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.

const response = await fetch(`https://testapi.linksmerchantservices.com/api/payments/${identifier}/refund`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ "refundedAlreadyAtProcessor": true, "amount": 0 }) }); const data = await response.json();

import requests response = requests.request( "POST", "https://testapi.linksmerchantservices.com/api/payments/{identifier}/refund", json={ "refundedAlreadyAtProcessor": True, "amount": 0 }, ) data = response.json()

<?php $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://testapi.linksmerchantservices.com/api/payments/<identifier>/refund"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); curl_setopt($ch, CURLOPT_HTTPHEADER, ["Content-Type: application/json"]); curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "refundedAlreadyAtProcessor": true, "amount": 0 }'); $response = curl_exec($ch); curl_close($ch);

package main import ( "fmt" "io" "net/http" "strings" ) func main() { req, _ := http.NewRequest("POST", "https://testapi.linksmerchantservices.com/api/payments/<identifier>/refund", strings.NewReader(`{ "refundedAlreadyAtProcessor": true, "amount": 0 }`)) req.Header.Set("Content-Type", "application/json") 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>/refund")) .header("Content-Type", "application/json") .method("POST", HttpRequest.BodyPublishers.ofString("{\n \"refundedAlreadyAtProcessor\": true,\n \"amount\": 0\n}")) .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>/refund") http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = uri.scheme == "https" request = Net::HTTP::Post.new(uri) request["Content-Type"] = "application/json" request.body = "{\n \"refundedAlreadyAtProcessor\": true,\n \"amount\": 0\n}" response = http.request(request) puts response.body

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