Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Payment or refund

Refund

Refund a successful debit transaction. You can only refund certain payment methods.

For more information, see the documentation, and for sample calls, see our public Postman collection.

post/payments/{uniqueId}

Path parameters

uniqueIdstring required

The unique transaction ID provided by Peach Payments.

Example:41a57893d4a44191be8cd410398464e6

The Peach Payments unique ID of the original debit transaction.

Request body

amountstring required

The payment request amount.

currencystring iso-4217 required

The currency code of the payment request amount as defined by ISO-4217.

paymentType'RF' required

Refund type of the transaction.

Example request

{
  "authentication": {
    "userId": "5fb5e392d6fa11ef9b3002f694e28f55",
    "password": "OMydSc7ewVmEKPZCAj2WxHoik",
    "entityId": "8ac7a4c894809722019482d1df62029d"
  },
  "amount": "22.50",
  "currency": "ZAR",
  "paymentType": "RF"
}

Response

OK.

OR

Example response

{
  "id": "41a57893d4a44191be8cd410398464e6",
  "amount": "22.50",
  "currency": "ZAR",
  "paymentBrand": "PEACHEFT",
  "paymentType": "RF",
  "result": {
    "code": "800.100.152",
    "description": "Request successfully processed."
  },
  "resultDetails": {
    "ExtendedDescription": "Purchase Approved OK",
    "AcquirerResponse": "Approved",
    "UserDisplayMessage": "Message 16 - Your session was created."
  },
  "connectorTxID1": "8ac7a49f7921f2fd0179230196ec4bbe",
  "timestamp": "2021-04-23T07:41:25.519947Z"
}