PHPackages                             wipop/wipop-payment - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. wipop/wipop-payment

ActiveLibrary

wipop/wipop-payment
===================

A PHP library for integrating Wipop payment gateway.

v0.9.0(2mo ago)01MITPHPPHP >=8.1.0CI passing

Since Nov 4Pushed 2mo agoCompare

[ Source](https://github.com/wipop-bbva/wipop-php-client)[ Packagist](https://packagist.org/packages/wipop/wipop-payment)[ RSS](/packages/wipop-wipop-payment/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (24)Versions (22)Used By (0)

Wipop PHP Client
================

[](#wipop-php-client)

A modern PHP client library for the Wipop payment processing API with full type safety and comprehensive error handling.

Features
--------

[](#features)

- **Card Charge Operations**
    - Payment link generation
    - Refunds
    - Pre-authorization creation
    - Pre-authorization confirmation
    - Pre-authorization reversal
    - Token generation
    - One-click charges
    - Recurring charges
- **Bizum Charge Operations**
    - Payment link creation
    - Refunds
- **Checkout Operations**
    - Payment link generation
    - Payment button
- **Merchant Operations**
    - Payment method discovery per terminal

Requirements
------------

[](#requirements)

- PHP 8.1 or higher
- Composer 2.x

Installation
------------

[](#installation)

```
composer require wipop-bbva/wipop-php-client
```

Before Getting Started
----------------------

[](#before-getting-started)

- Have completed the identification process during the Wipöp payment gateway contracting.
- Access the control panel in test mode (sandbox) from your account.
- Clearly define which method you will use to perform the integration in your system:

Quick Start
-----------

[](#quick-start)

```
use Wipop\Domain\ChargeMethod;
use Wipop\Operations\Charge\Params\CreateChargeParams;
use Wipop\Client\WipopClientConfiguration;
use Wipop\Client\Environment;
use Wipop\Client\WipopClient;
use Wipop\Domain\Value\OrderId;
use Wipop\Domain\ProductType;
use Wipop\Domain\Value\Terminal;

$configuration = new WipopClientConfiguration(
    Environment::SANDBOX,
    'your-merchant-id',
    'your-secret-key'
);

$client = new WipopClient($configuration);

$params = (new CreateChargeParams())
    ->method(ChargeMethod::CARD)
    ->amount(100.00)
    ->currency('EUR')
    ->description('Payment for order #123')
    ->productType(ProductType::PAYMENT_LINK)
    ->orderId(OrderId::fromString('1234ABCDEFGH'))
    ->terminal(new Terminal(1));

$charge = $client->chargeOperation()->create($params);
```

Example Scripts
---------------

[](#example-scripts)

Runnable CLI samples live under `docs/examples`. Each script loads credentials from `.env` and can be executed with `php docs/examples/.php`.

- `card-charge.php` / `bizum-charge.php`: create payment links for card or Bizum.
- `checkout.php` / `checkoutCustomer.php`: start a checkout session for anonymous or known customers.
- `preauth-confirm.php` / `preauth-cancel.php`: walk through the preauthorization flow.
- `payment-methods.php`: inspect the payment methods configured for your merchant.

Configuration
-------------

[](#configuration)

### Basic Configuration

[](#basic-configuration)

```
use Wipop\Client\WipopClientConfiguration;
use Wipop\Client\Environment;

$config = new WipopClientConfiguration(
    Environment::SANDBOX, // Environment::PRODUCTION for live operations
    'your-merchant-id',
    'your-secret-key'
);
```

### HTTP Configuration

[](#http-configuration)

```
use Wipop\Client\WipopClientConfiguration;
use Wipop\Client\WipopClientHttpConfiguration;
use Wipop\Client\Environment;

$httpConfig = new WipopClientHttpConfiguration(
    10_000,
    45_000
);

$config = new WipopClientConfiguration(
    Environment::SANDBOX,
    'merchant-id',
    'secret-key',
    $httpConfig
);
```

- `connectionRequestTimeout`: time (ms) to wait for a connection slot (default 5000).
- `responseTimeout`: time (ms) to wait for a full response (default 30000).

Charge Operations
-----------------

[](#charge-operations)

### Create Card Charge

[](#create-card-charge)

```
use Wipop\Domain\ChargeMethod;
use Wipop\Operations\Charge\Params\CreateChargeParams;
use Wipop\Domain\Value\OrderId;
use Wipop\Domain\ProductType;
use Wipop\Domain\Value\Terminal;

$cardCharge = (new CreateChargeParams())
    ->method(ChargeMethod::CARD)
    ->amount(100.00)
    ->currency('EUR')
    ->description('Card payment')
    ->orderId(OrderId::fromString('1234ABCDEFGH'))
    ->productType(ProductType::PAYMENT_LINK)
    ->terminal(new Terminal(1));

$response = $client->chargeOperation()->create($cardCharge);
```

### Create Bizum Charge

[](#create-bizum-charge)

```
$bizumCharge = (new CreateChargeParams())
    ->method(ChargeMethod::BIZUM)
    ->amount(50.00)
    ->currency('EUR')
    ->description('Bizum payment')
    ->orderId(OrderId::fromString('2345ABCDEFGH'))
    ->productType(ProductType::PAYMENT_LINK)
    ->terminal(new Terminal(1));

$response = $client->chargeOperation()->createCustomerCharge('customer-id', $bizumCharge);
```

### Confirm / Refund / Reverse / Capture

[](#confirm--refund--reverse--capture)

```
use Wipop\Operations\Charge\Params\ConfirmChargeParams;
use Wipop\Operations\Charge\Params\CaptureParams;
use Wipop\Operations\Charge\Params\RefundParams;
use Wipop\Operations\Charge\Params\ReversalParams;

$confirm = (new ConfirmChargeParams())->amount(75.00);
$client->chargeOperation()->confirm('transaction-id', $confirm);

$capture = (new CaptureParams())->amount(75.00);
$client->chargeOperation()->capture('transaction-id', $capture);

$refund = (new RefundParams())->amount(25.00);
$client->chargeOperation()->refund('transaction-id', $refund);

$reversal = (new ReversalParams())->reason('PRE_REVERSAL');
$client->chargeOperation()->reversal('transaction-id', $reversal);
```

### Tokenization / One-Click / Recurring / Pre-authorization

[](#tokenization--one-click--recurring--pre-authorization)

Use `CreateChargeParams::useCof(true)` to tokenize, `sourceId()` for one-click charges, `postType()` with `PostTypeMode::RECURRENT` for recurring payments, and `capture(false)` for pre-authorizations.

### Recurring Payments

[](#recurring-payments)

Recurring billing is achieved with the regular `chargeOperation()->create()` flow. Configure the payload to flag the transaction as recurring and, after the first successful charge, reuse the generated source identifier.

```
use Wipop\Domain\ChargeMethod;
use Wipop\Operations\Charge\Params\CreateChargeParams;
use Wipop\Domain\PostType;
use Wipop\Domain\PostTypeMode;
use Wipop\Domain\Value\Terminal;

// First charge: tokenize cardholder for future cycles
$initialCharge = (new CreateChargeParams())
    ->method(ChargeMethod::CARD)
    ->amount(29.99)
    ->useCof(true)
    ->postType(new PostType(PostTypeMode::RECURRENT))
    ->capture(true)
    ->redirectUrl('https://myweb.test/return')
    ->terminal(new Terminal(1));

$initialResponse = $client->chargeOperation()->create($initialCharge);
$sourceId = $initialResponse->card?->id; // persist for later cycles

// Subsequent cycles: reuse the stored sourceId
$recurringCharge = (new CreateChargeParams())
    ->method(ChargeMethod::CARD)
    ->amount(29.99)
    ->sourceId($sourceId)
    ->postType(new PostType(PostTypeMode::RECURRENT))
    ->terminal(new Terminal(1));

$client->chargeOperation()->create($recurringCharge);
```

```
use Wipop\Domain\ChargeMethod;
use Wipop\Operations\RecurrentPayment\Params\RecurrentPaymentParams;
use Wipop\Domain\Value\Terminal;

$recurringParams = (new RecurrentPaymentParams())
    ->method(ChargeMethod::CARD)
    ->amount(29.99)
    ->terminal(new Terminal(1));

$client->recurrentPaymentOperation()->create($recurringParams);
```

Checkout Operations
-------------------

[](#checkout-operations)

```
use Wipop\Operations\Checkout\Params\CheckoutParams;

$checkoutParams = (new CheckoutParams())
    ->amount(49.90)
    ->currency('EUR')
    ->description('Checkout example')
    ->orderId(OrderId::fromString('3456ABCDEFGH'))
    ->productType(ProductType::PAYMENT_GATEWAY)
    ->terminal(new Terminal(1))
    ->redirectUrl('https://your-site.com/success')
    ->sendEmail(true);

$checkout = $client->checkoutOperation()->createCheckout($checkoutParams);
```

### Checkout for an Existing Customer

[](#checkout-for-an-existing-customer)

If you need to create a checkout for a known customer, call `createCustomerCheckout()` with the customer public id.

```
use Wipop\Domain\Input\Customer;

$existingCustomer = new Customer(
    name: 'Ana',
    lastName: 'García',
    email: 'ana@example.com',
    publicId: 'cust_1234567890'
);

$checkoutParams = (new CheckoutParams())
    ->amount(120.00)
    ->currency('EUR')
    ->description('Customer checkout')
    ->orderId(OrderId::fromString('9012ABCDEFGH'))
    ->productType(ProductType::PAYMENT_GATEWAY)
    ->terminal(new Terminal(1))
    ->customer($existingCustomer);

$checkout = $client->checkoutOperation()->createCustomerCheckout('cust_1234567890', $checkoutParams);
```

Merchant Operations
-------------------

[](#merchant-operations)

Retrieve the payment methods enabled for a merchant/terminal combination.

```
use Wipop\Domain\ProductType;
use Wipop\Domain\Value\Terminal;

$methods = $client
    ->merchantOperation()
    ->listPaymentMethods(ProductType::PAYMENT_GATEWAY, new Terminal(1));

// ['CARD', 'BIZUM', 'GOOGLE_PAY']
```

Error Handling
--------------

[](#error-handling)

```
use Wipop\Exception\WipopException;

try {
    $charge = $client->chargeOperation()->create($params);
} catch (WipopException $exception) {
    // Inspect $exception->getCode()
}
```

API Reference
-------------

[](#api-reference)

- **WipopClient**: entrypoint for API operations.
- **WipopClientConfiguration / WipopClientHttpConfiguration / Environment**: client setup.
- **ChargeOperation**: create, confirm, refund, reverse, capture charges.
- **CheckoutOperation**: manage checkout sessions.
- **MerchantOperation**: inspect merchant metadata such as enabled payment methods.
- **RecurrentPaymentOperation**: convenience wrapper for recurring charge creation.
- **CreateChargeParams / ConfirmChargeParams / CaptureParams / RefundParams / ReversalParams**: payload builders.
- **CheckoutParams**: checkout payload builder.
- **Domain models**: `Charge`, `Checkout`, `Customer`, `Terminal`, `PaymentMethod`, `TransactionStatus`.

Support
-------

[](#support)

For support and questions, please contact the support team or [create an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/learning-about-issues/quickstart) in the project repository.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance87

Actively maintained with recent releases

Popularity1

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 99% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~13 days

Total

4

Last Release

62d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/3998e650f64bf335d75bda157e523024c4c111ce48d1bc714ea3f52b59205520?d=identicon)[openpay-admin](/maintainers/openpay-admin)

---

Top Contributors

[![victorvierna](https://avatars.githubusercontent.com/u/17448761?v=4)](https://github.com/victorvierna "victorvierna (98 commits)")[![mangelsnc](https://avatars.githubusercontent.com/u/1675834?v=4)](https://github.com/mangelsnc "mangelsnc (1 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/wipop-wipop-payment/health.svg)

```
[![Health](https://phpackages.com/badges/wipop-wipop-payment/health.svg)](https://phpackages.com/packages/wipop-wipop-payment)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[craftcms/cms

Craft CMS

3.6k3.6M2.6k](/packages/craftcms-cms)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[api-platform/symfony

Symfony API Platform integration

323.2M67](/packages/api-platform-symfony)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[api-platform/serializer

API Platform core Serializer

223.4M31](/packages/api-platform-serializer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)