HEhelcim
Device

Start A Refund

This operation requires the provided API key to have Processing permission set to 'Admin'.

post/devices/{code}/payment/refund

Request

  • Base URL
    https://api.helcim.com/v2
  • URL
    https://api.helcim.com/v2/devices/{code}/payment/refund
  • Auth
    API key in header api-token

Path parameters

codestring required

Four Digit Alphanumeric Code.

Request body

transactionAmountnumber required

The amount to be refunded in the currency on the original transaction.

originalTransactionIdinteger required

The identifier of the original transaction to refund. This identifier must correspond to the transaction Id of the original transaction to be refunded.

Example request

{
  "transactionAmount": 100.99,
  "originalTransactionId": 1234567890
}

Response

Accepted

Changes

No recorded changes to this operation across all 2 revisions of this API.