HEheylight
api

Contract Refund

Changed on

An endpoint that accepts an request for a refund on a given contract.

post/api/checkout/v1/refund/

Request

Request body

external_uuidstring uuid required

The UUID of the contract to be refunded.

amountstring decimal required

Amount to be refunded

amount_format'MINOR_UNIT' | 'DECIMAL'

The format of the amount provided. MINOR_UNIT = amount is an integer of the minor unit of the currency. eg 1000 is 10CHF. DECIMAL = Decimal representation as string. e.g. "10.00" is 10CHF

  • MINOR_UNIT - MINOR_UNIT
  • DECIMAL - DECIMAL
external_referencestring

An optional reference that will be stored with the refund transaction.

currencystring required

The currency to refund.

Response

successstring required

Whether the refund has been processed successfully: "true" or "false".

success_messagestring required

Details of the refund.

error_codestring

Why the refund was not processed. contract_not_refundable: refund the customer directly.

Changes

  • 3026811271f7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's property type changed from boolean to string for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added to the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status