Payments pipelines

Current version: 10.2

The integration and engagement logic used in the Payments API is implemented by pipelines that can be customized as needed. There is a pipeline for each method on the API.

GetPaymentOptions pipeline

Name:

GetPaymentOptions

Description:

The pipeline is responsible for performing a search against all payment options in the external commerce system.

Usage:

Called via the GetPaymentOptions method on the Connect API when searching for payment options.

Args:

Request - Contains the search criteria: ShopName. Is set prior to calling the pipeline.

Response - Contains a collection of PaymentOption objects. Is read after the pipeline is executed.

Processors:

No default processors

GetPaymentMethods pipeline

Name:

GetPaymentMethods

Description:

The pipeline is responsible for performing a search against all payment methods in the external commerce system.

Usage:

Called via the GetPaymentMethods method on the Connect API when searching for payment methods.

Args:

Request - Contains the search criteria: PaymentOption. Is set prior to calling the pipeline.

Response - Contains a collection of PaymentMethod objects. Is read after the pipeline is executed.

Processors:

No default processors

GetPricesForPayments pipeline

Name:

GetPricesForPayments

Description:

The pipeline is responsible for getting the payment pricing for a cart and a select group of payment and methods and options from the external commerce system.

Usage:

Called via the GetPricesForPayments method on the Connect API when searching for payment methods.

Args:

Request - Contains the search criteria: ShopName, PaymentLookups, and Cart. Is set prior to calling the pipeline.

Response - Contains a list of PaymentPrice objects. Is read after the pipeline is executed.

Processors:

No default processors

GetPaymentServiceUrl pipeline

Name:

GetPaymentServiceUrl

Description:

The pipeline is responsible for retrieving the URL for the card acceptance page of a federated payment service.

Usage:

Called via the GetPaymentServiceUrl method on the Connect API when performing checkout.

Args:

Request – Contains the merchant and customer information the payment service requires.

Response - Contains the URL for the card acceptance page.

Processors:

No default processors

GetPaymentServiceActionResult pipeline

Name:

GetPaymentServiceActionResult

Description:

The pipeline is responsible for retrieving the result of a transaction with a payment service.

Usage:

Called via the GetPaymentServiceActionResult method on the Connect API when performing checkout.

Args:

Request – Contains the result access code that uniquely identifies the transaction.

Response - Contains the result of the transaction as well as the card token that identifies the customer payment information.

Processors:

No default processors.

Do you have some feedback for us?

If you have suggestions for improving this article,