Skip to main content
POST
/
order
/
sales-return
Return Sale
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"
}
'
{
  "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

Refund processed successfully

result
boolean
Example:

true

message
string
Example:

"Transaction refunded successfully"

data
object