Reverse Parameters

This section outlines the required parameters for processing a reversal request.

Request Parameters

Request

Parameter Name	Type	Mandatory	Description
version	string(10)	optional	Protocol version. Default value: 1.0.1. Version 1.0 is deprecated.
order_id	string(1024)	mandatory	Order ID generated by the merchant.
merchant_id	integer(12)	mandatory	Merchant unique ID, assigned by Fondy during registration.
amount	integer(12)	mandatory	Order amount without separator.
currency	string(3)	mandatory	Order currency. Supported values: EUR — Euro USD — US Dollar GBP — Pound Sterling CZK — Czech Republic Koruna GEL — Georgian Lari UZS — Uzbekistan Sum Full list of supported currencies.
email	string(254)	optional	Merchant staff email who initiated the reversal.
comment	string(1024)	optional	Merchant comment on the reversal reason (UTF-8).
reverse_id	string(50)	optional	Idempotent reversal key to retry refund safely. Merchant should generate a unique value for each retry per order_id.
signature	string(40)	mandatory	Order signature. Required to verify merchant request consistency and authenticity. Signature generation algorithm please see at Signature generation for request and response.

Response

Parameter Name	Type	Description
order_id	string(1024)	Order ID generated by the merchant.
merchant_id	integer(12)	Merchant unique ID, assigned by Fondy during registration.
currency	string(3)	Order currency. See Supported Currencies.
reverse_status	string(50)	Order processing status. Possible values: created — Order has been created, but the customer has not entered payment details yet. The merchant must continue requesting the order status. processing — Order is still being processed by the payment gateway. The merchant must continue requesting the order status. declined — Order was declined by Fondy payment gateway, a bank, or an external payment system. approved — Order completed successfully, funds are held on the payer’s account and will be credited to the merchant soon. The merchant can provide the service or ship goods. expired — The order’s lifetime expired. reversed — A previously approved transaction was fully reversed. In this case, reversal_amount will be equal to actual_amount.
response_status	string(50)	Request processing status. If parameters sent by the merchant did not pass validation, the response will be failure; otherwise, it will be success.
reverse_id	string(50)	(Optional) Unique identifier for the reversal.
transaction_id	string(50)	(Optional) Unique transaction ID.
signature	string(40)	Order signature to verify merchant request consistency and authenticity. See Signature generation.
response_code	integer(4)	Order decline response code. Possible codes see in Response Codes.
response_description	string(1024)	Order response code description, see Response Codes.

Examples

Request

{
  "request": {
    "order_id": "test_12343242111",
    "currency": "GEL",
    "amount": "1",
    "signature": "29a569275265925c2ec356d3adada1929fd8bb8c",
    "merchant_id": "1549901"
  }
}

Normal Response

{
  "response": {
    "reverse_status": "approved",
    "order_id": "test_12343242111",
    "response_description": "",
    "response_code": "",
    "merchant_id": 1549901,
    "response_status": "success",
    "signature": "3656398d3e2aaf83138223cf97ce497871495904",
    "reverse_id": "",
    "reversal_amount": "16",
    "transaction_id": "2011080263"
  }
}

Response in case of error

{
  "response": {
    "error_code": 1007,
    "error_message": "Parameter `signature` is incorrect",
    "request_id": "e96rGwTzLjFmR",
    "response_status": "failure"
  }
}