---
title: "Payment actions, commands, pipelines"
slug: "payment-actions-commands-pipelines"
abstract: ""
---
# Payment actions, commands, pipelines

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

| **Action/Command/Pipeline** | **Description** |
| --- | --- |
| `Api/GetClientToken`<br><br>`GetClientTokenCommand`<br><br>`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.<br><br>Parameters: none |
| `[Put]Api/AddFederatedPayment`<br><br>`AddPaymentsCommand`<br><br>`AddPaymentsPipeline` | Sets the cart-level payment option.<br><br>Parameters:<br><br><ul><li>`cartId`: the identifier of the cart</li><li>`payment`: a federated payment component</li></ul> |
| `[Delete]Api/RemovePayment`<br><br>`RemovePaymentsCommand`<br><br>`RemovePaymentsPipeline` | Removes a federated payment from a cart.<br><br>Parameters:<br><br><ul><li>`cartId`: the identifier of the cart.</li><li>`paymentId`: the identifier of the payment to remove.</li></ul> |
| `[Get]Api/GetCartPaymentMethods`<br><br>`GetPaymentMethodsCommand`<br><br>`GetCartPaymentMethodsPipeline` | Retrieves a list of available payment methods based on the payment type selected and the items in the cart.<br><br>Parameters:<br><br><ul><li>`cartId`: the identifier of the cart.</li><li>`paymentType`: a string representing a selected payment type</li></ul><br><br>To retrieve a list of the available payment methods, the command:<br><br><ul><li>retrieves the payment methods</li><li>filters the payment methods based on the payment type</li><li>returns the available payment methods</li></ul> |
| `[Get]Api/GetCartPaymentOptions`<br><br>`GetCartPaymentOptionsCommand`<br><br>`GetCartPaymentOptionsPipeline` | Retrieves a list of cart payment options.<br><br>Parameter:<br><br><ul><li>`cartId`: the identifier of the cart.</li></ul><br><br>To return a list of available payment options, the command:<br><br><ul><li>retrieves the payment options</li><li>filters the payment options based on the cart contents</li><li>returns the available payment options</li></ul> |

> [!note]
> The following are not implemented:
>
> -   `[Get]Api/PaymentMethods`
>
> -   `[Get]Api/PaymentOptions`