sol-parts/payum-contracts

Shared contracts between a Payum host application and sol-parts payment gateway packages

Maintainers

Package info

github.com/sol-parts/payum-contracts

Homepage

pkg:composer/sol-parts/payum-contracts

Transparency log

Statistics

Installs: 0

Dependents: 0

Suggesters: 6

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v1.0.0 2026-08-16 22:12 UTC

Requires

Requires (Dev)

MIT 7bd249f524edbc591474aa4bfb72df804dd93bba

  • Andrii Didenko <andrii.woop@didenko.dev>

paymentgatewaypayumcontracts

Published on Packagist.org on 2026-08-17 11:09 UTC

This package is auto-updated.

Last update: 2026-08-17 11:10:56 UTC

README

Shared contracts between a Payum host application and the sol-parts/payum-* gateway packages — request primitives and narrow ports that keep gateway packages free of host code, in the spirit of symfony/contracts.

Installation

composer require sol-parts/payum-contracts

What is inside

Request\Api\DoCapture

Server-side finalization of a held payment: charging the blocked amount without a browser involved. It is a separate request rather than the core Capture because Capture serves the customer flow and may reply with an HttpRedirect to the bank page — fatal when dispatched from CLI or cron.

The host dispatches DoCapture; the gateway package that supports two-stage payments handles it with its Action/Api/DoCaptureAction.

use SolParts\PayumContracts\Request\Api\DoCapture;

$gateway->execute(new DoCapture($paymentDetails));

Request\GetApi + Action\GetApiAction

Extract the configured Api instance from an already built Payum gateway without reflection over the private Gateway::$apis. The action is not registered in gateway factories permanently — the caller (typically a console command doing direct API calls, e.g. refund or status outside the Payum workflow) attaches it at runtime:

use SolParts\PayumContracts\Action\GetApiAction;
use SolParts\PayumContracts\Request\GetApi;

$gateway = $payum->getGateway($gatewayName);
if ($gateway instanceof \Payum\Core\Gateway) {
    $gateway->addAction(new GetApiAction(ConcreteApi::class));
}

$gateway->execute($request = new GetApi());
$api = $request->getApi(); // instanceof ConcreteApi

Checkbox ports

Narrow ports for POS / fiscal-receipt gateways built on Checkbox AirCheck:

  • AircheckSessionProviderInterface — prepares one browser-to-POS AirCheck session (websocket endpoint, terminal, cash register).
  • PosOperatorCheckerInterface — answers whether the current actor is a POS operator allowed to trigger a fiscal receipt capture. POS gateways are operated by staff, so capture actions gate on this port; who qualifies as an operator is entirely the host's decision.

The host implements the ports and exposes them in its DI container. With Symfony, declare the interface-to-service alias explicitly — autowiring does not create it on its own:

# config/services.yaml
services:
    SolParts\PayumContracts\Checkbox\PosOperatorCheckerInterface: '@app.pos_operator_checker'

License

Released under the MIT License.