Sign in

v1

latestOpenAPI 3.0.32026-07-24164965.8 KB
api

Contract External Trade-In

An endpoint that triggers an externally-managed trade-in on a given contract.

post/api/checkout/v1/external-trade-in/

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 of the external trade-in.

Response

successstring required

Either "true" or "false".

success_messagestring required

A human-readable message describing the outcome.