Documentation
Charge Attempt Update

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

Properties
  • End User Failure Message
    A message explaining to the buyer why the payment failed. The message must be localized in the buyer's language, as specified in the payment page invocation URL.
  • Failure Reason
    The reason for the charge attempt's failure. This field is mandatory when the target state is set to 'FAILED'.
  • Reference
    A unique identifier for the charge attempt 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 charge attempt. Once the charge attempt is in the target state, further updates are not allowed.