Payment services

• Usage
• Create a payment service
  • Create the service
  • Make the service available

Usage

A payment service is a class that processes the payment defined in the subscription column payment_method.

Create a payment service

Create the service

Create a new laravel class in your project and implement Bpuig\Subby\Contracts\PaymentMethodService. Looking at the Free service would be a good starting point.

<?php

declare(strict_types=1);

namespace Bpuig\Subby\Services\PaymentMethods;

use Bpuig\Subby\Contracts\PaymentMethodService;

class Free implements PaymentMethodService
{
    /**
     * Charge desired amount
     * @return void
     */
    public function charge()
    {
        // Nothing is charged, no exception is raised
    }
}

Create your methods

In the following code, see an example of what could be a payment method service for a fictional credit card payment processor.

<?php

declare(strict_types=1);

namespace PaymentMethods;

use Bpuig\Subby\Contracts\PaymentMethodService;
use Bank\BankPackages\YourPaymentProcessor;
use Bpuig\Subby\Traits\IsPaymentMethod;

class CreditCard implements PaymentMethodService
{
    use IsPaymentMethod;

    private $amount;
    private $currency;
    private $creditCard;

    /**
     * You would need to retrieve whatever data you need from $this->subscription relationships
     * @return void
     */
    private function retrieveCreditCard() {
       $this->creditCard = $this->subscription->user->creditCards()->default;
    }
    
    /**
     * Charge desired amount with your favorite bank
     * @return void
     */
    public function charge()
    {
        $processor = new YourPaymentProcessor();
        $processor->setParameter('MERCHANT_CURRENCY', $this->currency);
        $processor->setParameter('MERCHANT_AMOUNT', $this->amount);
        $processor->setParameter('MERCHANT_CARD', $this->creditCard);
        $processor->pay();
    }
}

Make the service available

In your config file, add a name and the path of your new payment method:

'services' => [
        'schedule' => \Bpuig\Subby\Services\ScheduleService::class,
        'renewal' => \Bpuig\Subby\Services\RenewalService::class,
        'payment_methods' => [
            'free' => \Bpuig\Subby\Services\PaymentMethods\Free::class,
            'credit_card' => \PaymentMethods\CreditCard::class,
        ]
]