Sign in
api

Contract Refund

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

post/api/checkout/v1/refund/

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

successboolean required

Whether the refund has been processed successfully.

success_messagestring required

Details of the refund.

Changes

No recorded changes to this endpoint across all 1 revision of this API.