Return Sale

Return Sale

POST /order/sales-return

Return Sale

cURL

curl --request POST \
  --url https://testapi.fractalpay.com/api/v1/order/sales-return \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant_key": "{{merchant_key}}",
  "transaction_id": "txn_a7f0b5340a",
  "amount": "1.00"
}
'

import requests

url = "https://testapi.fractalpay.com/api/v1/order/sales-return"

payload = {
    "merchant_key": "{{merchant_key}}",
    "transaction_id": "txn_a7f0b5340a",
    "amount": "1.00"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    merchant_key: '{{merchant_key}}',
    transaction_id: 'txn_a7f0b5340a',
    amount: '1.00'
  })
};

fetch('https://testapi.fractalpay.com/api/v1/order/sales-return', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://testapi.fractalpay.com/api/v1/order/sales-return",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'merchant_key' => '{{merchant_key}}',
    'transaction_id' => 'txn_a7f0b5340a',
    'amount' => '1.00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://testapi.fractalpay.com/api/v1/order/sales-return"

	payload := strings.NewReader("{\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"transaction_id\": \"txn_a7f0b5340a\",\n  \"amount\": \"1.00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://testapi.fractalpay.com/api/v1/order/sales-return")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"transaction_id\": \"txn_a7f0b5340a\",\n  \"amount\": \"1.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://testapi.fractalpay.com/api/v1/order/sales-return")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"transaction_id\": \"txn_a7f0b5340a\",\n  \"amount\": \"1.00\"\n}"

response = http.request(request)
puts response.read_body

200

Example

{
  "result": true,
  "message": "Transaction refunded successfully",
  "data": {
    "sales_id": "txn_a8f83189a5",
    "order_createdfrom": "API",
    "amount": 1,
    "txn_id": "txn_lyWexIP9z2MJkrBBtscY",
    "txn_date": "2026-06-15T19:13:03.000Z",
    "linked_txn_id": "txn_a7f0b5340a",
    "transaction_id": "txn_a8f83189a5",
    "Status": "Success",
    "type": "Refund"
  }
}

Authorizations

Authorization · string · header · required

Use your Fractal API credentials.

Username = Client ID Password = Secret Key

Sandbox credentials can be generated from the Test Portal.

Body

application/json

merchant_key · string · required

The merchant's unique API key.

Example:

"{{merchant_key}}"

transaction_id · string · required

The pos_guid of the original completed transaction to refund. Must have is_status = 2 (completed).

Example:

"txn_a7f0b5340a"

amount · string · required

Amount to refund. Must not exceed the original transaction amount or the remaining refundable balance.

Example:

"1.00"

sub_merchant_key · string

Sub-merchant key, if applicable.

Example:

""

Response

200

application/json

Refund processed successfully

result · boolean

Example:

true

message · string

Example:

"Transaction refunded successfully"

data · object

Show child attributes