README

Paquete para la integración de Culqi enfocado en el usuario para el framework Laravel.

安装

composer install emm/culqi-cashier

配置

运行迁移

  php artisan migrate

可计费模型

在使用此包之前，请将 trait Facturable 添加到您的模型中，并实现函数 culqiAntiFraud，使用此示例中显示的参数。

   use Emm\CulqiCashier\Facturable;
   
   class User extends Authenticatable
   {
       use Facturable;

       /**
       * @return array
       */
       public function culqiAntiFraud(): array
       {
           return [
               "first_name" => $this->names,
               "last_name" => $this->last_names,
               "email" => $this->email,
               "address" => $this->address,
               "address_city" => $this->city',
               "country_code" => $this->country_code,
               "phone" => $this->mobile_phone,
               "metadata" => [], // opcional
           ];
       }
   }

API 密钥

CULQI_SECRET=
CULQI_PUBLIC=

货币配置

默认情况下，Culqi Cashier 使用索尔（PEN）作为货币。要更改货币，请在 .env 中进行设置。

CULQI_CURRENCY=USD

客户

获取所有客户

您可以通过调用 Customer 范围内的 list 函数来获取所有客户。响应将是 Illuminate\Support\Collection 类的实例。

use Emm\CulqiCashier\CulqiCashier;

$customers = CulqiCashier::Customer()->list();

创建新客户

最简单的方式是使用 createCulqiCustomer 方法。请记住，您必须实现 culqiAntiFraud。

$user->createCulqiCustomer()

更新客户数据

 $newData = ['email' => 'newemail@mail.com'];
$user->updateCulqiCustomer($newData)

支付方式

订单

    $description = 'Venta de Prueba';
    $sourceId = request()->get('culqi_token');//ID del objeto Token u objeto Tarjeta que se va usar para realizar el cargo.
    $antifraud = []; //opcional, si quieres reemplazar algunos datos de `culqiAntiFraud`
    $user->charge($amount, $description,$sourceId, $antifraud);

订阅

订阅必须在 Culqi 控制面板 中进行配置。

 $planId = 'plan_1'; // Nombre del plan que asignaste en el panel de culqi
 $sourceId = request()->get('culqi_token');//ID del objeto Token u objeto Tarjeta que se va usar para realizar el cargo.
 $user->newSubscription($planId', $sourceId);

许可证

CulqiCashier 是开源软件，许可协议为 MIT 许可证。