• English
  • Refund (Authorization Card Payment)

    Applicable market: ZA South Africa

    Request path

    /api/v2/payment/merchant/refund

    Initiate a refund for a captured card payment order, returning settled funds to the cardholder via the original card. Only applicable to orders with orderStatus = 2 (succeeded).

    Prerequisite: The order must have orderStatus = 2 (succeeded) before calling this API.

    ⚠️ If the pre-authorization has not been captured, use Cancel to cancel the authorization instead. Do not call Refund.

    Request Parameters

    ParameterTypeRequiredDescription
    originOrderNostringYesPlatform order number of the original captured order
    orderIdstringYesMerchant's unique order ID
    notifyUrlstringNoAsynchronous notification URL for refund results
    nonceStrstringYesRandom string (included in signature)
    requestTimeintegerYesUnix timestamp in milliseconds
    versionstringYes2.0.0.0

    Yes = Required · No = Optional

    Response Fields

    FieldDescription
    orderNoRefund order number (generated by PalmPay)
    orderIdMerchant order ID (echoed back)
    orderStatusOrder status (see Order Status)
    amountRefund amount (in cents)

    Example

    Request / Response

    curl 'https://open-gw-daily.palmpay-inc.com/api/v2/payment/merchant/refund' \
      -H 'CountryCode: ZA' -H 'Authorization: Bearer xxx' -H 'Content-Type: application/json' \
      -d '{"originOrderNo":"24260608092828582939","orderId":"testc9ffae997fc1",
           "notifyUrl":"/callback","nonceStr":"xxx","requestTime":16999258500,"version":"2.0.0.0"}'
    {
      "respCode": "00000000",
      "respMsg": "success",
      "status": true,
      "data": {
        "orderNo": "2424220903032435363613",
        "orderId": "testc9ffae997fc1",
        "orderStatus": 1,
        "amount": 1000
      }
    }