embedded.performPaymentInteraction

Description

This action occurs before a certain interaction is performed on a payment, and is particulary useful for third-party services interacting with payments. This action runs after the embedded.commerce.payments.action.before action and before the embedded.commerce.payments.action.after action. The main difference between these three actions is the methods each has access to and whether they occur before or after the payment interaction in Kibo eCommerce. The relevant payment interactions that this action responds to are:

  • AuthAndCapture
  • Authorize
  • Capture
  • Create
  • Credit
  • Decline
  • RequestCheck
  • Rollback
  • Void

Action Type Embedded
Full Action ID embedded.commerce.payments.action.performPaymentInteraction
Runs multiple custom functions? No

JavaScript File Structure

Action files share the following basic structure:

module.exports = function(context, callback) {
	// Your custom code here
	callback();
};
			

When you code the custom function for an action, you have access to two arguments:

callback—This argument follows the established JavaScript callback pattern: it takes an error as the first argument (or null if there is no error) and a result as the second argument (if required).

context—This argument provides the function access to relevant objects and methods that interface with Kibo eCommerce.

Context: Payment

The following methods and objects are available to this action through the use of the context argument.

Microservice Operation
This action corresponds to the microservice that performs payment actions.


Get Methods

Exec Methods

Context Objects Available to All Actions

Get

get.payment
Returns the payment transaction.
Parameters Type Description
N/A N/A N/A

Example:

context.get.payment();

Response:

For information about the properties in the response, refer to the REST API Help.





get.paymentAction
Returns a primitive list of strings naming the available payment actions.
Parameters Type Description
N/A N/A N/A

Example:

context.get.paymentAction();

Response:




Exec

exec.addPaymentInteraction
Adds a payment action.
Parameters Type Description
paymentInteraction string The application installation state. You can retrieve this object using the corresponding GET method.

Example:

context.exec.paymentInteraction("interaction");

Response:

Returns a payment interaction. For information about the properties in the response, refer to the REST API Help.





exec.setPaymentAmountRequested
Set a requested payment amount for the transaction.
Parameters Type Description
amount number The requested amount you want to set for the payment.

Example:

context.exec.setPaymentAmountRequested(37.00);

Response:

For information about the properties in the response, refer to the REST API Help.





exec.setPaymentAmountCollected
Set a collected payment amount for the transaction.
Parameters Type Description
amount number The collected amount you want to set for the payment.

Example:

context.exec.setPaymentAmountCollected(17.00);

Response:

For information about the properties in the response, refer to the REST API Help.





exec.setPaymentAmountCredited
Set a credited payment amount for the transaction.
Parameters Type Description
amount number The credited amount you want to set for the payment.

Example:

context.exec.setPaymentAmountCredited(20.00);

Response:

For information about the properties in the response, refer to the REST API Help.




Context Objects Available to All Actions

apiContext

Acesses Kibo eCommerce tenant information.

Properties Type Description
baseUrl string The base URL for the site.
basePciUrl string The base PCI URL for the site.
tenantPod string The name of the tenant pod in which the tenant resides.
appClaims string The application claims token.
appKey string The application key.
tenantId integer Unique identifier for the tenant.
siteId integer Unique identifier for the site. This ID is used at all levels of a store, catalog, and tenant to associate objects to a site.
masterCatalogId integer Unique identifier for the master catalog.
catalogId integer The unique identifier for the product catalog. Catalogs are part of a master catalog.
currencyCode string The default three-letter ISO currency code for monetary amounts.
previewDate date/time The date and time that the content is being viewed. This might be a future date if the content is previewed with an active date range set in the future.
localeCode string The locale code per the country code provided. This code determines the localized content to use and display.
correlationId string The unique identifier of the API request associated with the event action, which might contain multiple actions.
isAuthorizedAsAdmin Boolean Indicates whether the Dev Account user is authorized as an admin.
userClaims string The user claims token.

Example:

context.apiContext.baseUrl;




configuration
Receives a JSON response that contains information about the configuration data set in the Action Management JSON editor.
Properties Type Description
Varies object Custom fields and values that you can set in the Action Management JSON Editor.

Example:

context.configuration.customData;