Outcome of a payment processed by a repository app's custom payment provider, populated by the app's JavaScript payment function and returned to the e-commerce checkout process.

Implements: PaymentResult


Properties

PropertyReturnsDescription
nextHrefStringURL the customer should be redirected to next, for example to complete an off-site payment step.
paymentCompletedbooleanWhether the payment completed successfully.
paymentTransactionPaymentTransactionThe payment transaction record created for this payment, if one was created.
resultMessageStringMessage describing the payment result, suitable for showing to the customer.
resultSummaryStringShort summary of the payment result.

Methods

isPaymentCompleted() · setPaymentCompleted(boolean paymentCompleted) · getNextHref() · setNextHref(String nextHref) · getResultMessage() · setResultMessage(String resultMessage) · getResultSummary() · setResultSummary(String resultSummary) · getPaymentTransaction() · setPaymentTransaction(PaymentTransaction paymentTransaction)

isPaymentCompleted()

Returns: boolean

Whether the payment completed successfully.

setPaymentCompleted(boolean paymentCompleted)

Returns: void

Sets whether the payment completed successfully.

ParameterDescription
paymentCompletedtrue if the payment completed

getNextHref()

Returns: String

URL the customer should be redirected to next, for example to complete an off-site payment step.

setNextHref(String nextHref)

Returns: void

Sets the URL the customer should be redirected to next.

ParameterDescription
nextHrefthe next URL

getResultMessage()

Returns: String

Message describing the payment result, suitable for showing to the customer.

setResultMessage(String resultMessage)

Returns: void

Sets the message describing the payment result.

ParameterDescription
resultMessagethe result message

getResultSummary()

Returns: String

Short summary of the payment result.

setResultSummary(String resultSummary)

Returns: void

Sets the short summary of the payment result.

ParameterDescription
resultSummarythe result summary

getPaymentTransaction()

Returns: PaymentTransaction

The payment transaction record created for this payment, if one was created.

setPaymentTransaction(PaymentTransaction paymentTransaction)

Returns: void

Sets the payment transaction record created for this payment.

ParameterDescription
paymentTransactionthe payment transaction
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.