MultiPayment
MultiPayment permite gerenciar pagamentos de diversos gateways de pagamento. Atualmente suporta o Iugu.
Install / Use
/learn @Potelo/MultiPaymentREADME
Introdução
MultiPayment permite gerenciar pagamentos de diversos gateways de pagamento. Atualmente suporta o Iugu.
Requisitos
- PHP 8.0+
- Laravel 8.0+
Instalação
Instale esse pacote pelo composer:
composer require potelo/multi-payment "dev-main"
Configuração
Após instalar o pacote rode o comando abaixo para publicar as configurações no projeto Laravel
php artisan vendor:publish --provider="Potelo\MultiPayment\Providers\MultiPaymentServiceProvider"
Verifique se o arquivo multi-payment.php foi criado no diretório config/.
Agora configure as variáveis de ambiente no arquivo .env:
APP_ENV=local
MULTIPAYMENT_DEFAULT=iugu
#iugu
IUGU_ID=
IUGU_APIKEY=
Opcionalmente você pode configurar o Trait, para facilitar o uso do método charge junto a um usuário.
use Potelo\MultiPayment\MultiPaymentTrait;
class User extends Authenticatable
{
use MultiPaymentTrait;
}
Usando o Trait:
$usuario = User::find(1);
$usuario->charge($options, 'iugu', 10000);
Também é possível utilizar o Facade:
\Potelo\MultiPayment\Facades\MultiPayment::charge($options);
Utilizando
MultiPayment:
Usando a classe MultiPayment:
$payment = new \Potelo\MultiPayment\MultiPayment(); // gateway default será usado
// ou
$payment = new \Potelo\MultiPayment\MultiPayment('iugu');
// ou
$payment = new \Potelo\MultiPayment\MultiPayment();
$payment->setGateway('iugu');
InvoiceBuilder
$multiPayment = new \Potelo\MultiPayment\MultiPayment('iugu');
$invoiceBuilder = $multiPayment->newInvoice();
$invoice = $invoiceBuilder->setPaymentMethod('payment_method')
->addCustomer('name', 'email', 'tax_document', 'phone_area', 'phone_number')
->addCustomerAddress('zip_code', 'street', 'number')
->addItem('description', 'quantity', 'price')
->create();
Confira src/MultiPayment/Builders/InvoiceBuilder.php para saber quais métodos estão disponíveis.
CustomerBuilder
$multiPayment = new \Potelo\MultiPayment\MultiPayment('iugu');
$customerBuilder = $multiPayment->newCustomer();
$customer = $customerBuilder->setName('Nome')
->setEmail('email')
->setTaxDocument('01234567891')
->setPhone('999999999', '71')
->addAddress('45400000', 'Rua', 'S/N')
->create();
Confira src/MultiPayment/Builders/CustomerBuilder.php para saber quais métodos estão disponíveis.
getInvoice
$invoiceId = '312ASDHGZXSGRTET312ASDHGZXSGRTET';
$payment = new \Potelo\MultiPayment\MultiPayment('iugu');
$foundInvoice = $payment->getInvoice($invoiceId);
charge
$options = [
'amount' => 10000,
'customer' => [
'name' => 'Nome do cliente',
'email' => 'email@example.com',
'tax_document' => '12345678901',
'phone_area' => '71',
'phone_number' => '999999999',
'address' => [
'street' => 'Rua do cliente',
'number' => '123',
'complement' => 'Apto. 123',
'district' => 'Bairro do cliente',
'city' => 'Cidade do cliente',
'state' => 'SP',
'zip_code' => '12345678',
],
],
'items' => [
[
'description' => 'Produto 1',
'quantity' => 1,
'price' => 10000,
],
[
'description' => 'Produto 2',
'quantity' => 2,
'price' => 5000,
],
],
'payment_method' => 'credit_card',
'credit_card' => [
'number' => '1234567890123456',
'month' => '12',
'year' => '2022',
'cvv' => '123',
'first_name' => 'João',
'last_name' => 'Maria'
],
];
$payment = new \Potelo\MultiPayment\MultiPayment();
$payment->setGateway('iugu')->charge($options);
| atributo | obrigatório | tipo | descrição | exemplo |
|-------------------------------|---------------------------------------------------------------------|--------------------------------|-------------------------------------------|---------------------------------------|
| amount | obrigatório caso items não seja informado | int | valor em centavos | 10000 |
| customer | obrigatório | array | array com os dados do cliente | ['name' => 'Nome do cliente'...] |
| customer.name | obrigatório | string | nome do cliente | 'Nome do cliente' |
| customer.email | obrigatório | string | email do cliente | 'joaomaria@email.com' |
| customer.tax_document | | string | cpf ou cnpj do cliente | '12345678901' |
| birth_date | | string formato yyyy-mm-dd | data de nascimento | '01/01/1990' |
| customer.phone_number | | string | telefone | '999999999' |
| customer.phone_area | | string | DDD | '999999999' |
| customer.address | obrigatório para o método de pagamento bank_slip | array | array com os dados do endereço do cliente | ['street' => 'Rua do cliente'...] |
| customer.address.street | obrigatório | string | nome da rua | 'Nome da rua' |
| customer.address.number | obrigatório | string | número da casa | '123' |
| customer.address.district | obrigatório | string | bairro | 'Bairro do cliente' |
| customer.address.city | obrigatório | string | cidade | 'Salvador' |
| customer.address.state | obrigatório | string | estado | 'Bahia' |
| customer.address.complement | obrigatório | string | complemento | 'Apto. 123' |
| customer.address.zip_code | obrigatório | string | cep | '12345678' |
| items | obrigatório caso amount não tenha sido informado | array | array com os itens da compra | [['description' => 'Produto 1',... |
| items.description | obrigatório | string | descrição do item | 'Produto 1' |
| items.quantity | obrigatório | int | quantidade do item | 1 |
| items.price | obrigatório | int | valor do item | 10000 |
| payment_method | | 'credit_card','bank_slip' | método de pagamento | 'credit_card' |
| expires_at | obrigatório caso payment_method seja 'bank_slip' ou 'pix' | string no formato yyyy-mm-dd | data de expiração da fatura | 2021-10-10 |
| credit_card | obrigatório caso payment_method seja 'credit_card' | array | array com os dados do cartão de crédito | ['number' => '1234567890123456',... |
| credit_card.token | | string | token do cartão para o gateway escolhido | 'abcdefghijklmnopqrstuvwxyz' |
| credit_card.number | **obri
