Sign in
Operations

Refund operation

Refund operation by its ID. If the parameter attribute partialAmount is set, refund will be partial, otherwise invocation of this method will cause full refund.

post/operations/{id}/refund

Request body

partialAmountnumber nullable

Refund amount.

Response

Refunded operation

idinteger

Transaction ID in the UDS database.

dateCreatedstring date-time

Transaction date.

action'PURCHASE' required

Transaction type.

state'NORMAL' | 'CANCELED' | 'REVERSAL'

Transaction lifecycle status:

  • NORMAL — active transaction, loyalty benefits applied
  • CANCELED — transaction was canceled, no loyalty impact
  • REVERSAL — transaction was refunded, loyalty benefits reversed (points returned, cashback deducted)
pointsnumber

The amount of points which changed customer balance as a result of the operation.

A negative value means write-off of bonus points and a positive value means point accrual.

certificatePointsnumber nullable

Number of deducted certificate points.

receiptNumberstring nullable

Receipt number.

Changes

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