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
| Property | Returns | Description |
|---|---|---|
| nextHref | String | URL the customer should be redirected to next, for example to complete an off-site payment step. |
| paymentCompleted | boolean | Whether the payment completed successfully. |
| paymentTransaction | PaymentTransaction | The payment transaction record created for this payment, if one was created. |
| resultMessage | String | Message describing the payment result, suitable for showing to the customer. |
| resultSummary | String | Short 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.
| Parameter | Description |
|---|---|
paymentCompleted | true 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.
| Parameter | Description |
|---|---|
nextHref | the 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.
| Parameter | Description |
|---|---|
resultMessage | the result message |
getResultSummary()
Returns: String
Short summary of the payment result.
setResultSummary(String resultSummary)
Returns: void
Sets the short summary of the payment result.
| Parameter | Description |
|---|---|
resultSummary | the 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.
| Parameter | Description |
|---|---|
paymentTransaction | the payment transaction |