1. Sitecore Experience Commerce

Payment actions, commands, pipelines

Version:

The following table describes the payment actions, commands, and pipelines:

Action/Command/PipelineDescription
Api/GetClientToken

GetClientTokenCommand

GetClientTokenPipeline		Retrieves a client token from the integrated third-party payment provider. This token allows the storefront payment iFrame to communicate directly with the payment provider.

Parameters: none
[Put]Api/AddFederatedPayment

AddPaymentsCommand

AddPaymentsPipeline		Sets the cart-level payment option.

Parameters:

  • cartId: the identifier of the cart
  • payment: a federated payment component
[Delete]Api/RemovePayment

RemovePaymentsCommand

RemovePaymentsPipeline		Removes a federated payment from a cart.

Parameters:

  • cartId: the identifier of the cart.
  • paymentId: the identifier of the payment to remove.
[Get]Api/GetCartPaymentMethods

GetPaymentMethodsCommand

GetCartPaymentMethodsPipeline		Retrieves a list of available payment methods based on the payment type selected and the items in the cart.

Parameters:

  • cartId: the identifier of the cart.
  • paymentType: a string representing a selected payment type


To retrieve a list of the available payment methods, the command:

  • retrieves the payment methods
  • filters the payment methods based on the payment type
  • returns the available payment methods
[Get]Api/GetCartPaymentOptions

GetCartPaymentOptionsCommand

GetCartPaymentOptionsPipeline		Retrieves a list of cart payment options.

Parameter:

  • cartId: the identifier of the cart.


To return a list of available payment options, the command:

  • retrieves the payment options
  • filters the payment options based on the cart contents
  • returns the available payment options
Note

The following are not implemented:

  • [Get]Api/PaymentMethods

  • [Get]Api/PaymentOptions

If you have suggestions for improving this article, let us know!