Kirby Pay

# Payment

# Definition

The Payment class inside of it, has a connection with the service or driver selected in your Kirby configuration file config.php, and as the name describes, it performs the payments of the package.

The Payment class is part of the Resource object and you can use all these methods to improve functionallity.

# Methods

# order

  • params: (Buyer $customer, Items $items, Extras $extras, string $token, string $type = 'card', Shipping $shipping = null)
  • returns: Payment

This static method creates a new Payment and Customer resource.

use Beebmx\KirbyPay\Payment;
use Beebmx\KirbyPay\Elements\Buyer;
use Beebmx\KirbyPay\Elements\Item;
use Beebmx\KirbyPay\Elements\Items;

Payment::order(
  new Buyer(
    'John Doe',
    'example@email.com',
    '1122334455',
  ),
  new Items([
    new Item('Producto 01', 300.00, 1)
  ]),
  'token'
);

# orderWithCustomer

This static method creates a new Payment resource from a Customer instance.

use Beebmx\KirbyPay\Payment;
use Beebmx\KirbyPay\Customer;
use Beebmx\KirbyPay\Elements\Item;
use Beebmx\KirbyPay\Elements\Items;

$customer = Customer::find('4f139ef0-484a-4749-a51f-5ffe339dd1c1');

Payment::orderWithCustomer(
  $customer,
  new Items([
    new Item('Producto 01', 300.00, 1)
  ])
);

# Charge

  • params: (Buyer $customer, Items $items, Extras $extras, string $token, string $type = 'card', Shipping $shipping = null)
  • returns: Payment

This static method creates a new Payment resource.

use Beebmx\KirbyPay\Payment;
use Beebmx\KirbyPay\Elements\Buyer;
use Beebmx\KirbyPay\Elements\Item;
use Beebmx\KirbyPay\Elements\Items;

Payment::charge(
  new Buyer(
    'John Doe',
    'example@email.com',
    '1122334455',
  ),
  new Items([
    new Item('Producto 01', 300.00, 1)
  ]),
  'token'
);

# serviceUrl

  • params: none
  • returns: string

This static method returns the URL of a payment in the driver service.

use Beebmx\KirbyPay\Payment;

Payment::serviceUrl();

# getPaymentMethods

  • params: none
  • returns: array

This static method returns an array with all the available payment methods in the driver service.

use Beebmx\KirbyPay\Payment;

Payment::getPaymentMethods();

# parseAmount

  • params: (int $amount)
  • returns: float

This static method returns the float amount depending of the driver service.

use Beebmx\KirbyPay\Payment;

Payment::parseAmount(100);

← Customer →