Refund a payment

This method allows you to refund a payment.

• URL syntax: /api/v2/merchant/refund
• Method: POST

Request parameters

Name	Type	Details	Mandatory	Description
payment_id	int		Y	SysPay payment reference of the payment you want to refund.
reference	string	UNIQUE, [ -~]+ (max: 85 ascii printable characters)	Y	Merchant refund identifier, must be unique for each refund.
amount	int		Y	The amount to refund back to the customer must be equal or less than the original payment amount. Amount in cents (500 XXX = 5.00 XXX)
currency	string	[A-Z]3	Y	The refund currency, should be the same as the currency of the original payment (ISO-4217).
description	string	Max length 300	N	The description of this refund.
extra	string	Max length 300	N	An extra parameter that is passed back to the merchant when sending a redirect or event message.
ems_url	string		N	This parameter overrides the default ems_url set in the user backend.

Example request

{
  "payment_id": "246806",
  "reference": "65ea390f60422",
  "description": "Refund 1.00EUR on payment with id:246806",
  "amount": "100",
  "currency": "EUR",
  "extra": {
    "internalKey1": "internalValue1",
    "internalKey2": "internalValue2"
  }
}

Response parameters

The response in this case is a Refund object.

Example response

{
  "class": "refund",
  "id": 246809,
  "reference": "65ea390f60422",
  "amount": 100,
  "currency": "EUR",
  "status": "SUCCESS",
  "processing_time": 1709848849,
  "description": "Refund 1.00EUR on payment with id:246806",
  "extra": "Array",
  "failure_category": null,
  "payment": {
    "class": "payment",
    "id": 246806,
    "reference": "65ea38551bb46",
    "amount": 10000,
    "currency": "EUR",
    "status": "SUCCESS",
    "preauth_expiration_date": null,
    "action_url": null,
    "flow": "API",
    "processing_time": 1709848662,
    "source": 2544,
    "contract": "SysPay (8737476)",
    "descriptor": "Test Contract",
    "extra": null,
    "description": null,
    "account_id": 23918,
    "merchant_id": 2744,
    "merchant_login": "23918001",
    "settlement_date": 1709848662,
    "failure_category": null,
    "chip_and_pin_status": null,
    "capture_date": null,
    "token": {
      "class": "token",
      "id": "83377",
      "status": "ACTIVE",
      "action_url": null,
      "booking_id": "65ea33bc7446e",
      "check_in_date": "2024-03-30",
      "check_out_date": "2024-04-06",
      "booking_details": {
        "class": "booking_details",
        "type": "HOTEL",
        "booking_id": "65ea33bc7446e",
        "check_in_date": "2024-03-30",
        "check_out_date": "2024-04-06",
        "total_booking_amount": "100000",
        "booking_currency": "EUR"
      },
      "creation_date": "1709847486",
      "expiration_date": "1712439484",
      "description": "Booking 65ea33bc7446e from 2024-03-30 to 2024-04-06.",
      "extra": "Array",
      "customer": {
        "class": "customer",
        "email": "john.doe+65ea33bc72e00@gmail.com",
        "language": "en",
        "firstname": "John",
        "lastname": "Doe",
        "billing_address": {
          "class": "billing_address",
          "address1": "55 rue du Faubourg Saint-Honoré",
          "address2": null,
          "address3": null,
          "city": "Paris",
          "country": "FR",
          "postal_code": "75008"
        }
      },
      "payment_method": {
        "class": "payment_method",
        "type": "CREDITCARD",
        "validation_status": "NOT_VALIDATED",
        "validation_date": null,
        "invalid_reason": null,
        "display": "4491-70xx-xxxx-4007",
        "details": {
          "class": "payment_method_details",
          "fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
          "holder": "Card Holder Name",
          "scheme": null,
          "exp_month": "01",
          "exp_year": "2025"
        }
      },
      "moto_instance_id": null,
      "mandate": {
        "class": "mandate",
        "status": "ACTIVE",
        "currency": "EUR",
        "end_reason": null,
        "start_date": 1709847486,
        "end_date": null
      },
      "payment": null
    },
    "customer": {
      "class": "customer",
      "email": "john.doe+65ea33bc72e00@gmail.com",
      "language": "en",
      "firstname": null,
      "lastname": null,
      "billing_address": {
        "class": "billing_address",
        "address1": "55 rue du Faubourg Saint-Honoré",
        "address2": null,
        "address3": null,
        "city": "Paris",
        "country": "FR",
        "postal_code": "75008"
      }
    },
    "payment_method": {
      "class": "payment_method",
      "type": "CREDITCARD",
      "validation_status": "NOT_VALIDATED",
      "validation_date": null,
      "invalid_reason": null,
      "display": "4491-70xx-xxxx-4007",
      "details": {
        "class": "payment_method_details",
        "fingerprint": "1c2cd558-d343-49c4-ac98-0bee7846c0c4",
        "holder": "Card Holder Name",
        "scheme": null,
        "exp_month": "01",
        "exp_year": "2025"
      }
    },
    "processor_reference": null,
    "qr_code": null
  }
}