Refund Notification

We will notify you when a refund changes its status to the Notification URL you setup in the Merchant Dashboard.

You need to respond with HTTP code 204 (No Content)!

Refund notification format:

Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

{
  "Refund": {
    "ID": 16405,
    "Created": "20170803095139",
    "MerchantTransactionID": "s2ptest_g28",
    "OriginatorTransactionID": null,
    "InitialPaymentID": 3005389,
    "Amount": 100,
    "Currency": "EUR",
    "Description": "",
    "TypeID": 5,
    "SiteID": 30201,
    "Details": null,
    "Customer": null,
    "BillingAddress": null,
    "BankAddress": null,
    "Articles": null,
    "Status": {
      "ID": 2,
      "Info": "Success",
      "Reasons": null
    }
  }
}

Response:

204 No Content

Whenever a a refund changes its status, we notify you of the event and whether it was successful or not. In case of a non-successful refund, additional information will be sent in the Reasons Code and Info fields.

For more information about the reasons of a wrong request response see our section GlobalPay Return Codes.

Below is a case of a non-successful refund for WeChat payment method when the customer Wallet is closed and the refund cannot be processed. Additional information to why the payment got to this status will be sent in the Reasons Code and Info fields:

Refund notification format:

Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

{
  "Refund": {
    "ID": 18882,
    "Created": "20171213124659",
    "MerchantTransactionID": "893817297012",
    "OriginatorTransactionID": null,
    "InitialPaymentID": 3464340,
    "Amount": "100",
    "Currency": "EUR",
    "Description": null,
    "TypeID": 1,
    "SiteID": null,
    "Details": null,
    "Customer": null,
    "BillingAddress": null,
    "BankAddress": null,
    "Articles": null,
    "Status": {
      "ID": 4,
      "Info": "Failed",
      "Reasons": [
        {
          "Code": "5000",
          "Info": "USER_ACCOUNT_ABNORMAL"
        }
      ]
    }
  }
}

Response:

204 No Content

Another case of a non-successful refund is for Alipay payment method when the customer Wallet is closed and the refund cannot be processed. Additional information to why the payment got to this status will be sent in the Reasons Code and Info fields:

Refund notification format:

Authorization: Basic MzAyMDE6aEo1Um9iWXg5cjdGZk53Q3ZIWTlMWEhxcXIrRkV6cmM3YUp2UVFrNEdhejFtZzdSeXk=

{
  "Refund": {
    "ID": 18882,
    "Created": "20171213124659",
    "MerchantTransactionID": "893817297012",
    "OriginatorTransactionID": null,
    "InitialPaymentID": 3464340,
    "Amount": "100",
    "Currency": "EUR",
    "Description": null,
    "TypeID": 1,
    "SiteID": null,
    "Details": null,
    "Customer": null,
    "BillingAddress": null,
    "BankAddress": null,
    "Articles": null,
    "Status": {
      "ID": 4,
      "Info": "Failed",
      "Reasons": [
        {
          "Code": "5000",
          "Info": "BUYER_NOT_EXIST"
        }
      ]
    }
  }
}

Response:

204 No Content