Reverse parameters¶
Request parameters
| Parameters | 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 which is generated by merchant |
merchant_id |
integer(12) | mandatory | Merchant unique ID. Generated by Flitt during merchant 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 mandatory CZK — Czech Republic Koruna UAH — Ukrainian Hryvnia GEL - Georgian lari UZS - Uzbekistan sum Full list of supported currencies |
email |
string(254) | optional | Merchant staff emailm who initiated the reversal |
comment |
string(1024) | optional | Merchant comment on reversal reason UTF-8 |
reverse_id |
string(50) | optional | Idempotent reversal key to retry refund safely. Merchant should generate 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 |
| Parameters | Type | Description |
|---|---|---|
order_id |
string(1024) | Order ID which is generated by merchant. |
merchant_id |
integer(12) | Merchant unique ID. Generated by Flitt during merchant registration. |
currency |
string(3) | Order currency. Supported values: see Currencies |
reverse_status |
string(50) | Order processing status. Can contain the following values:created — order has been created, but the customer has not entered payment details yet; merchant must continue to request the status of the orderprocessing — order is still in processing by payment gateway; merchant must continue to request the status of the orderdeclined — order is declined by Flitt payment gateway or by a bank or by an external payment systemapproved — order completed successfully, funds are held on the payer’s account and soon will be credited of the merchant; merchant can provide the service or ship goodsexpired — order lifetime expired.reversed — previously approved transaction was fully reversed. In this case, parameter reversal_amount will be equal to actual_amount |
response_status |
string(50) | Request processing status. If parameters sent by merchant did not pass validation then failure, else success |
reverse_id |
string(50) | optional |
transaction_id |
string(50) | optional |
signature |
string(40) | Order signature. Required to verify merchant request consistency and authenticity. Signature generation algorithm please see at Signature generation for request and response |
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": {
"order_id": "test_12343242111",
"currency": "GEL",
"amount": "1",
"signature": "29a569275265925c2ec356d3adada1929fd8bb8c",
"merchant_id": "1549901"
}
}
{
"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": {
"error_code": 1007,
"error_message": "Parameter `signature` is incorrect",
"request_id": "e96rGwTzLjFmR",
"response_status": "failure"
}
}