The Payment Provider Gateway documentation uses the Magento 2.3.x version of the Braintree module as a reference application. The Braintree module was removed in Magento 2.4.0. The concepts described in this guide are still applicable to Magento 2.4.0, but the code samples are not supported.
Magento payment provider gateway
What is Magento payment provider gateway
The Magento 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 Magento sales management and external payment service provider using Magento payment provider gateway:
Magento 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 Magento payment provider gateway:
- Payment provider gateway structure
- Gateway Command
- Gateway Command Pool
- Request Builder
- Gateway Client
- Response Validator
- Response Handler
Terms used
| Term | Description |
|---|---|
| Magento sales management | Magento 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:
|