betalabs/engine-sdk-gateway
| Install | |
|---|---|
composer require betalabs/engine-sdk-gateway |
|
| Latest Version: | 5.3.7 |
| PHP: | >=7.2 |
| Laravel: | 7 · 8 · 9 |
| Older releases: | 5 · 6 |
| License: | MIT |
| Last Updated: | Oct 28, 2026 |
| Links: | GitHub · Packagist |
engine-sdk-gateway
This package provides gateway interfaces used in Engine for your internal apps.
Installation
$ composer require betalabs/engine-sdk-gateway
Pix Automático (recurring Pix debit)
Optional contract for gateways that support Pix Automático. A gateway driver
opts in by implementing the two interfaces below; Engine checks instanceof
and refuses the payment method when the driver does not implement them, so
drivers that do not support it are not affected.
| Interface | Role |
|---|---|
PixAutomaticAuthorizer |
authorizePixAutomatic, refreshPixAutomaticAuthorization, cancelPixAutomaticAuthorization |
PixAutomaticCharger |
schedulePixAutomaticCharge, retryPixAutomaticCharge, cancelPixAutomaticCharge |
PixAutomaticAuthorization |
The authorization itself. Implemented by Engine (a persisted model), like Transaction: the gateway reads what to create from the getters and writes the gateway's answer through the setters. |
How it maps to what already exists:
- The authorization plays the role the tokenized card plays for credit cards: it is created once per subscription, after the payer approves it in the bank app.
- Each cycle is a scheduled debit (
schedulePixAutomaticCharge) created days before the due date. Nothing is paid when it returns: theTransactioniswaiting paymentand the final status arrives later (postback or polling), using the existingTransactionStatus. - A debit refused for lack of balance is the only retryable one. The gateway must say which kind of failure it was in the history's status reason.
- Enums (
PixAutomaticPeriodicity,PixAutomaticAmountMode,PixAutomaticAuthorizationStatus) use the Central Bank of Brazil's concepts, not any gateway's vocabulary: each driver translates them.
Design and rollout: docs/payments/pix-automatico-plano.md in the Engine repository.
Related Packages
Contracts to establish communication between Engine and your internal apps
Version History
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| 5.3.7 | >=7.2 | ^7.0| | MIT | |
| 5.3.6 | >=7.2 | ^7.0| | MIT | |
| 5.3.5 | >=7.2 | ^7.0| | MIT | |
| 5.3.4 | >=7.2 | ^7.0| | MIT | |
| 5.3.3 | >=7.2 | ^7.0| | MIT | |
| 5.3.2 | >=7.2 | ^7.0| | MIT | |
| 5.3.1 | >=7.2 | 5.7.*| | MIT | |
| 5.3.0 | >=7.2 | 5.7.*| | MIT | |
| 5.2.0 | >=7.2 | 5.7.*| | MIT | |
| 5.1.0 | >=7.2 | 5.7.*| | MIT | |
| 5.0.2 | >=7.2 | 5.7.*| | MIT | |
| 5.0.1 | >=7.2 | 5.7.*| | MIT | |
| 5.0.0 | >=7.2 | 5.7.*| | MIT | |
| 4.1.0 | >=7.2 | 5.7.*| | MIT | |
| 4.0.0 | >=7.2 | 5.7.*| | MIT | |
| 3.0.2 | >=7.2 | 5.7.*| | MIT | |
| 3.0.1 | >=7.2 | 5.7.*| | MIT | |
| 3.0.0 | >=7.2 | 5.7.*| | MIT | |
| 2.1.2 | >=7.2 | 5.7.*| | MIT | |
| 2.1.1 | >=7.2 | 5.7.*| | MIT | |
| 2.1.0 | >=7.2 | 5.7.*| | MIT | |
| 2.0.0 | >=7.2 | 5.7.*| | MIT | |
| 1.2.0 | >=7.2 | 5.7.*| | MIT | |
| 1.1.1 | >=7.2 | 5.7.*| | MIT | |
| v1.1.0 | >=7.2 | 5.7.*| | MIT | |
| 1.0.0 | >=7.2 | 5.7.*| | MIT | |
| 0.7.3 | >=7.2 | 5.7.*| | MIT | |
| 0.7.2 | >=7.2 | ^6.0 | MIT | |
| 0.7.1 | >=7.2 | 5.7.*| | MIT | |
| 0.7.0 | >=7.2 | 5.7.*| | MIT |
Showing the latest 30 of 33. See every release on Packagist