The Payment Provider Gateway documentation uses the Magento 2.3 (now Adobe Commerce and Magento Open Source) of the Braintree module as a reference application. The Braintree module was removed in version 2.4.0. The concepts described in this guide are still applicable to version 2.4.x, but the code samples are not supported.
Commerce payment provider gateway
What is Adobe Commerce payment provider gateway
The Adobe Commerce payment provider gateway is a mechanism that allows you to integrate your stores with payment service providers. As a result, you can create and handle transactions based on order details.
The following diagram shows a simplified interaction flow between Adobe Commerce sales management and external payment service provider using Commerce payment provider gateway:
Commerce payment provider supports the following payment operations:
authorize: process authorization transaction; funds are blocked on customer account, but not withdrawn
sale: process authorization transaction and capture automatically, funds are withdrawn
capture: withdraw previously authorized amount
refund: return previously withdrawn customer funds
void: cancel transfer of funds from customer account
What's in this chapter
The topics of this chapter are conceptual and describe the components of the Commerce payment provider gateway:
Terms used
Term | Description |
---|---|
Commerce sales management | Commerce interfaces that provide the ability to create orders, invoices, and shipments. |
Payment service provider, payment provider, payment processor | Online service for accepting electronic payments, like PayPal, Authorize.Net and so on. |
Payload | Data used for a transaction. Might include the following:
|