Payment reversal

Payment reversal
  • Reversal request reverses original previously processed invoice. Reversed amount will be returned to the same credit card as it was used in invoice payment. Reversal can be requested for full or partial original invoice amount.
  • Payment reversal must be used only due to technical error.
Payment reversal request description and example
  • Method: POST, URL: /invoice/reverse/{invoice_ref}
Field Usage Description
amount optional Reversal amount. Decimal point – “.” Two decimal digits available (example: 200.00). (amount value > 0)
currency optional 3 letters currency code, if specified should be the same with original transaction currency
send_fraud optional true/false - send fraud information to FD
  • Fields for signature calculation: <invoice_ref><X-Shop-Name><X-Nonce><ShopPassword>
Request example:
  "amount": 9.99
Payment reversal response description and example
Field Description
id Transaction identifier
amount Transaction initial amount
invoice_id Number of invoice
payment_id Reversal payment identifier
target_payment_id Additional payment identifier
currency Transaction currency
minor_amount Value given in the minor units
created_date Invoice creating date (datetime)
updated_date Latest update date (datetime)
transaction_type REVERSE
status Reversal transaction status
error_code Code of error
error_message Description of error
shop_code Code of shop
invoice_ref Initial invoice reference
Response example:
  "id": 2638,
  "amount": 9.99,
  "invoice_id": 19408,
  "payment_id": "19676711",
  "target_payment_id": null,
  "currency": "EUR",
  "minor_amount": 999,
  "created_date": "2017-03-29T15:51:20.042Z",
  "updated_date": "2017-03-29T15:51:20.042Z",
  "transaction_type": "REVERSE",
  "status": "SUCCEEDED",
  "error_code": null,
  "error_message": null,
  "shop_code": "TEST",
  "invoice_ref": "YNdudK2FnkGtQ978iJsHAhsUr"