README

Hoppa payment gateway driver for x-laravel/payline.

Requirements

PHP ^8.3
Laravel ^12.0 | ^13.0
x-laravel/payline ^1.0

Installation

composer require x-laravel/payline-hoppa-driver

Configuration

Add the hoppa block to config/payline.php under gateways:

'gateways' => [
    'hoppa' => [
        'api_url'      => env('HOPPA_API_URL', 'https://api.hoppa.com'),
        'merchant_id'  => env('HOPPA_MERCHANT_ID'),
        'merchant_key' => env('HOPPA_MERCHANT_KEY'),
    ],
],

Set the corresponding environment variables in .env:

PAYLINE_DRIVER=hoppa

HOPPA_API_URL=https://api.hoppa.com
HOPPA_MERCHANT_ID=your-merchant-id
HOPPA_MERCHANT_KEY=your-merchant-key

Usage

Charging a payment

use XLaravel\Payline\DTOs\Card;
use XLaravel\Payline\DTOs\PaymentRequest;

$data = PaymentRequest::fromPayable(
    payable: $order,
    card: new Card(
        holderName: 'John Doe',
        number: '4111111111111111',
        expiryMonth: '12',
        expiryYear: '2030',
        cvv: '123',
    ),
    installments: 1,
    customerIp: $request->ip(),
);

$response = $order->pay('hoppa')->charge($data);

Hoppa uses a 3DS redirect flow. On success, pay() returns a PaymentResponse with status = Pending and a redirectUrl pointing to Hoppa's 3DS page:

if ($response->requiresRedirect()) {
    return redirect($response->redirectUrl);
}

Handling the callback

Payline handles the callback automatically via its built-in route (/payline/callbacks/hoppa). After 3DS completes, Hoppa POSTs to this URL and the user is redirected to payline.callback_success_url or payline.callback_failure_url.

You can listen to the dispatched events for any post-payment logic:

use XLaravel\Payline\Events\PaymentSucceeded;
use XLaravel\Payline\Events\PaymentFailed;

class HandlePaymentSucceeded
{
    public function handle(PaymentSucceeded $event): void
    {
        $event->payment;     // Payment model
        $event->transaction; // Transaction model
        $event->response;    // PaymentResponse DTO
    }
}

Refund

use XLaravel\Payline\DTOs\RefundData;
use XLaravel\Payline\Facades\Payline;

Payline::via('hoppa')->refund(
    new RefundData(
        gatewayTransactionId: $transaction->gateway_transaction_id,
        amount: 5000, // kuruş
        currency: 'TRY',
    ),
    $payment,
    $transaction,
);

Void (Cancel)

Hoppa's cancel endpoint requires the original payment amount. Pass it via metadata:

use XLaravel\Payline\DTOs\VoidData;

Payline::via('hoppa')->void(
    new VoidData(
        gatewayTransactionId: $transaction->gateway_transaction_id,
        metadata: ['amount' => $transaction->amount],
    ),
    $payment,
    $transaction,
);

BIN Lookup

Hoppa provides a BIN lookup service that resolves card family and type from the first 8 digits of a card number. Enable it by setting payline.bin_lookup.default to hoppa:

// config/payline.php
'bin_lookup' => [
    'default' => env('PAYLINE_BIN_LOOKUP_DRIVER', 'hoppa'),
    'drivers' => [],
],

The BIN lookup driver automatically uses the same api_url configured under payline.gateways.hoppa. Usage:

use XLaravel\Payline\DTOs\Card;
use XLaravel\Payline\BinLookupManager;

$card = (new Card(
    holderName: 'John Doe',
    number: '4111111111111111',
    expiryMonth: '12',
    expiryYear: '2030',
    cvv: '123',
))->resolveProfile(app(BinLookupManager::class));

// $card->profile->family → 'Maximum'
// $card->profile->type   → CardType::Credit

When used with PaymentRequest, the resolved CardProfile enables automatic gateway routing via GatewayRouter:

$data = PaymentRequest::fromPayable(
    payable: $order,
    card: $card, // profile already resolved
    installments: 3,
);

$order->pay()->charge($data); // cheapest gateway selected automatically

Hoppa `Card_Type`	Payline `CardType`
CREDIT	`CardType::Credit`
DEBIT	`CardType::Debit`

Supported Operations

Operation	Supported	Notes
Pay (3DS)	✓	Redirects to Hoppa's 3DS page
Authorize	✗	Not supported by Hoppa
Capture	✗	Not supported by Hoppa
Refund	✓	Partial or full via `/api/services/OrderReturn`
Void/Cancel	✓	Requires `metadata["amount"]`
Webhooks	✗	Hoppa uses callback-only flow

Testing

# Build first (once per PHP version)
DOCKER_BUILDKIT=0 docker compose --profile php83 build

# Run tests
docker compose --profile php83 up
docker compose --profile php84 up
docker compose --profile php85 up

Or directly:

composer test

License

This package is open-sourced software licensed under the MIT license.

x-laravel / payline-hoppa-driver

Maintainers

Package info

Statistics

Security