Documentation
Refund Update

A request to update the state of a refund. The refund must be associated with a processor created by the invoking payment web app.

Properties
  • Failure Reason
    The reason for the refund's failure. This field is mandatory when the target state is set to 'FAILED'.
  • Reference
    A unique identifier for the refund within the systems of the external service provider. This field is mandatory when the target state is set to 'SUCCESSFUL'.
  • Target State
    The desired end state of the refund. Once the refund is in the target state, further updates are not allowed.