README

Este documento descreve como utilizar o cliente PHP para integração com a API Asaas.

Requisitos

PHP 8.1 ou superior
Composer para gerenciar dependências

Instalação

Certifique-se de que o Composer está instalado no seu ambiente.

Adicione o cliente ao seu projeto:

composer require leandroferreirama/asaas-client

Crie um arquivo .env na raiz do projeto e configure a variável de ambiente com seu token de acesso:
```
ASAAS_TOKEN=seu_token_de_acesso_aqui
```

Exemplos

Seguem alguns exemplos de uso, mas não deixem de explorar todos os exemplos disponíveis na pasta example.

Criar Subconta

O exemplo abaixo demonstra como criar uma subconta utilizando o cliente PHP:

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use Asaas\AsaasConfig;
use Asaas\HttpClient;
use Asaas\Endpoints\SubaccountEndpoint;
use Asaas\Models\Subaccount;
use Asaas\Config\VariavelAmbiente;

// Token de acesso
VariavelAmbiente::load(__DIR__.'/../');
$token = getenv('ASAAS_TOKEN');

// Configuração
$config = new AsaasConfig(AsaasConfig::ENV_SANDBOX);
$httpClient = new HttpClient($token, $config);
$subaccountEndpoint = new SubaccountEndpoint($httpClient);

// Criar subconta
$subaccount = new Subaccount(
    'Minha Subconta',
    'email@email.com',
    '00000000000000',
    '41000000000',
    5000.00,
    '000',
    '00000000',
    companyType: 'LIMITED'
);

$response = $subaccountEndpoint->create($subaccount);
var_dump($response);

Exemplo de Resposta da API

array(2) {
    ["status_code"] => int(200),
    ["response"] => array(25) {
        ["object"] => string(7) "account",
        ["id"] => string(36) "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        ["name"] => string(16) "Minha Subconta",
        ["email"] => string(22) "email@exemplo.com",
        ["loginEmail"] => string(22) "email@exemplo.com",
        ["phone"] => NULL,
        ["mobilePhone"] => string(11) "41999999999",
        ["address"] => NULL,
        ["addressNumber"] => string(3) "947",
        ["complement"] => NULL,
        ["province"] => NULL,
        ["postalCode"] => string(8) "82000000",
        ["cpfCnpj"] => string(14) "00000000000000",
        ["birthDate"] => NULL,
        ["personType"] => string(8) "JURIDICA",
        ["companyType"] => string(7) "LIMITED",
        ["city"] => int(13405),
        ["state"] => string(2) "PR",
        ["country"] => string(6) "Brasil",
        ["site"] => NULL,
        ["walletId"] => string(36) "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        ["apiKey"] => string(166) "chave_api_generica",
        ["accountNumber"] => array(3) {
            ["agency"] => string(4) "0001",
            ["account"] => string(6) "123456",
            ["accountDigit"] => string(1) "1"
        },
        ["incomeValue"] => int(5000),
        ["commercialInfoExpiration"] => NULL
    }
}

Criar Customer

O exemplo abaixo demonstra como criar um customer utilizando o cliente PHP:

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use Asaas\AsaasConfig;
use Asaas\HttpClient;
use Asaas\Endpoints\CustomerEndpoint;
use Asaas\Models\Customer;
use Asaas\Config\VariavelAmbiente;

// Token de acesso
VariavelAmbiente::load(__DIR__.'/../');
$token = getenv('ASAAS_TOKEN');

// Configuração
$config = new AsaasConfig(AsaasConfig::ENV_SANDBOX);
$httpClient = new HttpClient($token, $config);
$customerEndpoint = new CustomerEndpoint($httpClient);

// Criar customer
$customer = new Customer(
    'Cliente Completo',
    '12345678909', // CPF ou CNPJ
    'cliente@teste.com', // Email
    '+551140028922', // Telefone fixo
    '+5511999998888', // Telefone celular
    '88000000', // CEP
    'Rua Completa', // Endereço
    '123', // Número
    'Apto 10', // Complemento
    'Bairro Completo', // Bairro
    'Ref123', // Referência externa (opcional)
    true // Notificações desativadas
);

$response = $customerEndpoint->create($customer);
var_dump($response);

Exemplo de Resposta da API

array(2) {
    ["status_code"] => int(200),
    ["response"] => array(30) {
        ["object"] => string(8) "customer",
        ["id"] => string(16) "cus_000006579435",
        ["dateCreated"] => string(10) "2025-03-18",
        ["name"] => string(16) "Cliente Completo",
        ["email"] => string(17) "cliente@teste.com",
        ["company"] => NULL,
        ["phone"] => string(12) "551140028922",
        ["mobilePhone"] => string(13) "5511999998888",
        ["address"] => string(12) "Rua Completa",
        ["addressNumber"] => string(3) "123",
        ["complement"] => string(7) "Apto 10",
        ["province"] => string(15) "Bairro Completo",
        ["postalCode"] => string(8) "88000000",
        ["cpfCnpj"] => string(11) "12345678909",
        ["personType"] => string(6) "FISICA",
        ["deleted"] => bool(false),
        ["additionalEmails"] => NULL,
        ["externalReference"] => string(6) "Ref123",
        ["notificationDisabled"] => bool(true),
        ["observations"] => NULL,
        ["municipalInscription"] => NULL,
        ["stateInscription"] => NULL,
        ["canDelete"] => bool(true),
        ["cannotBeDeletedReason"] => NULL,
        ["canEdit"] => bool(true),
        ["cannotEditReason"] => NULL,
        ["city"] => NULL,
        ["cityName"] => NULL,
        ["state"] => NULL,
        ["country"] => string(6) "Brasil"
    }
}

Criar Cobrança Parcelada via Boleto

O exemplo abaixo demonstra como criar uma cobrança parcelada via boleto utilizando o cliente PHP:

<?php

require_once __DIR__ . '/../vendor/autoload.php';

use Asaas\AsaasConfig;
use Asaas\Config\VariavelAmbiente;
use Asaas\HttpClient;
use Asaas\Endpoints\BoletoEndpoint;
use Asaas\Factories\ChargeFactory;

try {
    // Token de acesso
    VariavelAmbiente::load(__DIR__.'/../');
    $token = getenv('ASAAS_TOKEN');
    
    // Configuração
    $config = new AsaasConfig(AsaasConfig::ENV_SANDBOX);
    $httpClient = new HttpClient(
        $token,
        $config
    );

    $boletoEndpoint = new BoletoEndpoint($httpClient);

    // Criando uma cobrança parcelada via boleto
    $boletoCharge = ChargeFactory::createCharge(
        'cus_000006562001', // ID do cliente
        'BOLETO', // Tipo de cobrança
        0, // Valor não necessário para parcelamento
        '2025-04-01', // Data de vencimento
        'Pedido Parcelado 056985', // Descrição (opcional)
        '056985' // Referência externa (opcional)
    );

    // Adicionando detalhes do parcelamento
    $boletoCharge->addInstallmentFields(
        3,       // Número de parcelas
        450.0,   // Valor total (opcionalmente pode usar installmentValue)
        null     // Valor individual de cada parcela (calculado automaticamente)
    );
    $boletoCharge->addInterest(1);
    $boletoCharge->addFine(2, 'PERCENTAGE');
    $boletoCharge->addDiscount(10, 5, 'PERCENTAGE');

    // Criando a cobrança e obtendo o Identification Field
    $response = $boletoEndpoint->create($boletoCharge);

    // Resposta final combinada
    var_dump($response);
} catch (Exception $e) {
    echo 'Erro: ' . $e->getMessage();
}

Exemplo de Resposta da API

array(2) {
    ["status_code"] => int(200),
    ["response"] => array(39) {
        ["object"] => string(7) "payment",
        ["id"] => string(20) "pay_t5bbsyj68t8ceh23",
        ["dateCreated"] => string(10) "2025-03-18",
        ["customer"] => string(16) "cus_000006562001",
        ["paymentLink"] => NULL,
        ["value"] => int(177),
        ["netValue"] => float(175.01),
        ["originalValue"] => NULL,
        ["interestValue"] => NULL,
        ["description"] => string(10) "Pedido 123",
        ["billingType"] => string(6) "BOLETO",
        ["canBePaidAfterDueDate"] => bool(true),
        ["pixTransaction"] => NULL,
        ["status"] => string(7) "PENDING",
        ["dueDate"] => string(10) "2025-12-01",
        ["originalDueDate"] => string(10) "2025-12-01",
        ["paymentDate"] => NULL,
        ["clientPaymentDate"] => NULL,
        ["installmentNumber"] => NULL,
        ["invoiceUrl"] => string(44) "https://sandbox.asaas.com/i/t5bbsyj68t8ceh23",
        ["invoiceNumber"] => string(8) "08021834",
        ["externalReference"] => string(3) "123",
        ["deleted"] => bool(false),
        ["anticipated"] => bool(false),
        ["anticipable"] => bool(false),
        ["creditDate"] => NULL,
        ["estimatedCreditDate"] => NULL,
        ["transactionReceiptUrl"] => NULL,
        ["nossoNumero"] => string(8) "10720541",
        ["bankSlipUrl"] => string(48) "https://sandbox.asaas.com/b/pdf/t5bbsyj68t8ceh23",
        ["lastInvoiceViewedDate"] => NULL,
        ["lastBankSlipViewedDate"] => NULL,
        ["discount"] => array(4) {
            ["value"] => float(10),
            ["limitDate"] => NULL,
            ["dueDateLimitDays"] => int(5),
            ["type"] => string(10) "PERCENTAGE"
        },
        ["fine"] => array(2) {
            ["value"] => float(2),
            ["type"] => string(10) "PERCENTAGE"
        },
        ["interest"] => array(2) {
            ["value"] => float(1),
            ["type"] => string(10) "PERCENTAGE"
        },
        ["postalService"] => bool(false),
        ["custody"] => NULL,
        ["escrow"] => NULL,
        ["refunds"] => NULL
    }
}

Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo LICENSE para mais detalhes.

leandroferreirama / asaas-client

Maintainers

Details

README

Requisitos

Instalação

Exemplos

Criar Subconta

Exemplo de Resposta da API

Criar Customer

Exemplo de Resposta da API

Criar Cobrança Parcelada via Boleto

Exemplo de Resposta da API

Licença