Essa SDK foi construída com o intuito de torná-la flexível, de forma que todos possam utilizar todas as features, de todas as versões de API.
Você pode acessar a documentação oficial do Pagar.me acessando esse link.
- Instalação
- Configuração
- Transações
- Criando uma transação
- Capturando uma transação
- Estornando uma transação
- Retornando transações
- Retornando uma transação
- Retornando recebíveis de uma transação
- Retornando um recebível de uma transação
- Retornando o histórico de operações de uma transação
- Notificando cliente sobre boleto a ser pago
- Retornando eventos de uma transação
- Calculando Pagamentos Parcelados
- Testando pagamento de boletos
- Estornos
- Chargebacks
- Cartões
- Planos
- Assinaturas
- Postbacks
- Saldo do recebedor principal
- Operações de saldo
- Recebível
- Transferências
- Antecipações
- Contas bancárias
- Recebedores
- Clientes
- Links de pagamento
- Buscas avançadas (Elasticsearch)
Instale a biblioteca utilizando o comando
composer require pagarme/pagarme-php
Para incluir a biblioteca em seu projeto, basta fazer o seguinte:
<?php
require('vendor/autoload.php');
$pagarme = new PagarMe\Client('SUA_CHAVE_DE_API');- Se necessário for é possível definir headers http customizados para os requests. Para isso basta informá-los durante a instanciação do objeto
Client:
<?php
require('vendor/autoload.php');
$pagarme = new PagarMe\Client(
'SUA_CHAVE_DE_API',
['headers' => ['MEU_HEADER_CUSTOMIZADO' => 'VALOR HEADER CUSTOMIZADO']]
); E então, você pode poderá utilizar o cliente para fazer requisições ao Pagar.me, como nos exemplos abaixo.
Nesta seção será explicado como utilizar transações no Pagar.me com essa biblioteca.
<?php
$transaction = $pagarme->transactions()->create([
'amount' => 1000,
'payment_method' => 'credit_card',
'card_holder_name' => 'Anakin Skywalker',
'card_cvv' => '123',
'card_number' => '4242424242424242',
'card_expiration_date' => '1220',
'customer' => [
'external_id' => '1',
'name' => 'Nome do cliente',
'type' => 'individual',
'country' => 'br',
'documents' => [
[
'type' => 'cpf',
'number' => '00000000000'
]
],
'phone_numbers' => [ '+551199999999' ],
'email' => '[email protected]'
],
'billing' => [
'name' => 'Nome do pagador',
'address' => [
'country' => 'br',
'street' => 'Avenida Brigadeiro Faria Lima',
'street_number' => '1811',
'state' => 'sp',
'city' => 'Sao Paulo',
'neighborhood' => 'Jardim Paulistano',
'zipcode' => '01451001'
]
],
'shipping' => [
'name' => 'Nome de quem receberá o produto',
'fee' => 1020,
'delivery_date' => '2018-09-22',
'expedited' => false,
'address' => [
'country' => 'br',
'street' => 'Avenida Brigadeiro Faria Lima',
'street_number' => '1811',
'state' => 'sp',
'city' => 'Sao Paulo',
'neighborhood' => 'Jardim Paulistano',
'zipcode' => '01451001'
]
],
'items' => [
[
'id' => '1',
'title' => 'R2D2',
'unit_price' => 300,
'quantity' => 1,
'tangible' => true
],
[
'id' => '2',
'title' => 'C-3PO',
'unit_price' => 700,
'quantity' => 1,
'tangible' => true
]
]
]);<?php
$capturedTransaction = $pagarme->transactions()->capture([
'id' => 'ID_OU_TOKEN_DA_TRANSAÇÃO',
'amount' => VALOR_TOTAL_COM_CENTAVOS
]);<?php
$refundedTransaction = $pagarme->transactions()->refund([
'id' => 'ID_OU_TOKEN_DA_TRANSAÇÃO',
]);Esta funcionalidade também funciona com estornos parciais, ou estornos com split. Por exemplo:
<?php
$partialRefundedTransaction = $pagarme->transactions()->refund([
'id' => 'ID_OU_TOKEN_DA_TRANSAÇÃO',
'amount' => 'VALOR_PARCIAL_DO_ESTORNO',
]);<?php
$refundedTransactionWithSplit = $pagarme->transactions()->refund([
'id' => 'ID_OU_TOKEN_DA_TRANSAÇÃO',
'amount' => '6153',
'split_rules' => [
[
'id' => 'sr_cj41w9m4d01ta316d02edaqav',
'amount' => '3000',
'recipient_id' => 're_cj2wd5ul500d4946do7qtjrvk'
],
[
'id' => 'sr_cj41w9m4e01tb316dl2f2veyz',
'amount' => '3153',
'recipient_id' => 're_cj2wd5u2600fecw6eytgcbkd0',
'charge_processing_fee' => 'true'
]
]
]);<?php
$transactions = $pagarme->transactions()->getList();Se necessário, você pode utilizar parâmetros para filtrar essa busca, por exemplo, se quiser filtrar apenas transações pagas, você pode utilizar o código abaixo:
<?php
$paidTransactions = $pagarme->transactions()->getList([
'status' => 'paid'
]);<?php
$transactions = $pagarme->transactions()->get([
'id' => 'ID_DA_TRANSAÇÃO'
]);<?php
$transactionPayables = $pagarme->transactions()->listPayables([
'id' => 'ID_DA_TRANSAÇÃO'
]);<?php
$transactionPayable = $pagarme->transactions()->getPayable([
'transaction_id' => 'ID_DA_TRANSAÇÃO',
'payable_id' => 'ID_DO_PAYABLE'
]);<?php
$transactionOperations = $pagarme->transactions()->listOperations([
'id' => 'ID_DA_TRANSAÇÃO',
]);<?php
$transactionPaymentNotify = $pagarme->transactions()->collectPayment([
'id' => 'ID_DA_TRANSAÇÃO',
'email' = > '[email protected]'
]);<?php
$transactionEvents = $pagarme->transactions()->events([
'id' => 4262049,
]);Essa rota não é obrigatória para uso. É apenas uma forma de calcular pagamentos parcelados com o Pagar.me.
Para fins de explicação, utilizaremos os seguintes valores:
amount: 1000,
free_installments: 4,
max_installments: 12,
interest_rate: 3
O parâmetro free_installments decide a quantidade de parcelas sem juros. Ou seja, se ele for preenchido com o valor 4, as quatro primeiras parcelas não terão alteração em seu valor original.
Nessa rota, é calculado juros simples, efetuando o seguinte calculo:
valorTotal = valorDaTransacao * ( 1 + ( taxaDeJuros * numeroDeParcelas ) / 100 )
Então, utilizando os valores acima, na quinta parcela, a conta ficaria dessa maneira:
valorTotal = 1000 * (1 + (3 * 5) / 100)
Então, o valor a ser pago na quinta parcela seria de 15% da compra, totalizando 1150.
Você pode usar o código abaixo caso queira utilizar essa rota:
<?php
$calculateInstallments = $pagarme->transactions()->calculateInstallments([
'amount' => 'VALOR_DA_TRANSAÇÃO_EM_CENTAVOS',
'free_installments' => 'PARCELAS_SEM_JUROS',
'max_installments' => 'MÁXIMO_DE_PARCELAS',
'interest_rate' => 'TAXA_DE_JUROS_AO_MÊS'
]);<?php
$paidBoleto = $pagarme->transactions()->simulateStatus([
'id' => 'ID_DA_TRANSAÇÃO',
'status' => 'paid'
]);É possível visualizar todos os estornos que ocorreram em sua conta, basta utilizar o código abaixo:
<?php
$refunds = $pagarme->refunds()->getList();Se preferir, você pode utilizar filtros para trazer apenas o estorno de uma transação em específico, por exemplo:
<?php
$transactionRefunds = $pagarme->refunds()->getList([
'transaction_id' => 'ID_DA_TRANSAÇÃO_ESTORNADA'
]);Da mesma forma que estornos, você pode visualizar todos os chargebacks que ocorreram em sua conta.
<?php
$transactionChargebacks = $pagarme->refunds()->getList();Sempre que você faz uma requisição através da nossa API, nós guardamos as informações do portador do cartão, para que, futuramente, você possa utilizá-las em novas cobranças, ou até mesmo implementar features como one-click-buy.
<?php
$card = $pagarme->cards()->create([
'holder_name' => 'Yoda',
'number' => '4242424242424242',
'expiration_date' => '1225',
'cvv' => '123'
]);<?php
$cards = $pagarme->cards()->getList();Se necessário, você pode filtrar por algum dado específico do cartão, por exemplo, o código abaixo irá trazer todos os cartões da bandeira visa:
<?php
$visaCards = $pagarme->cards()->getList([
'brand' => 'visa'
]);<?php
$card = $pagarme->cards()->get([
'id' => 'ID_DO_CARTÃO'
]);Representa uma configuração de recorrência a qual um cliente consegue assinar. É a entidade que define o preço, nome e periodicidade da recorrência
<?php
$plan = $pagarme->plans()->create([
'amount' => '15000',
'days' => '30',
'name' => 'The Pro Plan - Platinum - Best ever'
]);<?php
$plans = $pagarme->plans()->getList();<?php
$plan = $pagarme->plans()->get(['id' => '123456']);<?php
$updatedPlan = $pagarme->plans()->update([
'id' => '365403',
'name' => 'The Pro Plan - Susan',
'trial_days' => '7',
]);<?php
$substription = $pagarme->subscriptions()->create([
'plan_id' => 123456,
'payment_method' => 'credit_card',
'card_number' => '4111111111111111',
'card_holder_name' => 'UNIX TIME',
'card_expiration_date' => '0722',
'card_cvv' => '123',
'postback_url' => 'http://postbacj.url',
'customer' => [
'email' => '[email protected]',
'name' => 'Unix Time',
'document_number' => '75948706036',
'address' => [
'street' => 'Rua de Teste',
'street_number' => '100',
'complementary' => 'Apto 666',
'neighborhood' => 'Bairro de Teste',
'zipcode' => '11111111'
],
'phone' => [
'ddd' => '01',
'number' => '923456780'
],
'sex' => 'other',
'born_at' => '1970-01-01',
],
'metadata' => [
'foo' => 'bar'
]
]);Criando assinaturas utilizando card_id
<?php
// Criando o cartão
$card = $pagarme->cards()->create([
'holder_name' => 'Yoda',
'number' => '4242424242424242',
'expiration_date' => '1225',
'cvv' => '123'
]);
$substription = $pagarme->subscriptions()->create([
'plan_id' => 365403,
'card_id' => $card->id,
'payment_method' => 'credit_card',
'postback_url' => 'http://www.pudim.com.br',
'customer' => [
'email' => '[email protected]',
'name' => 'Unix Time',
'document_number' => '75948706036',
'address' => [
'street' => 'Rua de Teste',
'street_number' => '100',
'complementary' => 'Apto 666',
'neighborhood' => 'Bairro de Teste',
'zipcode' => '88370801'
],
'phone' => [
'ddd' => '01',
'number' => '923456780'
],
'sex' => 'other',
'born_at' => '1970-01-01',
],
'metadata' => [
'foo' => 'bar'
]
]);<?php
$substription = $pagarme->subscriptions()->create([
'plan_id' => 123456,
'card_id' => 'card_abc123456',
'payment_method' => 'credit_card',
'postback_url' => 'http://www.pudim.com.br',
'customer' => [
'email' => '[email protected]',
'name' => 'Unix Time',
'document_number' => '75948706036',
'address' => [
'street' => 'Rua de Teste',
'street_number' => '100',
'complementary' => 'Apto 666',
'neighborhood' => 'Bairro de Teste',
'zipcode' => '88370801'
],
'phone' => [
'ddd' => '01',
'number' => '923456780'
],
'sex' => 'other',
'born_at' => '1970-01-01',
],
'amount' => 10000,
'split_rules' => [
[
'recipient_id' => 're_abc1234abc1234abc1234abc1',
'percentage' => 20,
'liable' => true,
'charge_processing_fee' => true,
],
[
'recipient_id' => 're_abc1234abc1234abc1234abc1',
'percentage' => 80,
'liable' => true,
'charge_processing_fee' => true,
]
],
'metadata' => [
'foo' => 'bar'
]
]);<?php
$substription = $pagarme->subscriptions()->get([
'id' => 123456
]);<?php
$substription = $pagarme->subscriptions()->getList();Se necessário, você pode aplicar filtros em sua busca. Por exemplo, se quiser trazer todas as assinatura de um certo plano, você pode utilizar o código abaixo:
<?php
$planSubstriptions = $pagarme->subscriptions()->getList([
'plan_id' => 'ID_DO_PLANO'
]);<?php
$updatedSubscription = $pagarme->subscriptions()->update([
'id' => 1234,
'plan_id' => 4321,
'payment_method' => 'boleto'
]);<?php
$canceledSubscription = $pagarme->subscriptions()->cancel([
'id' => 12345
]);<?php
$substriptionTransactions = $pagarme->subscriptions()->transactions([
'subscription_id' => 1245
]);<?php
$settledCharges = $pagarme->subscriptions()->settleCharges([
'id' => 12345,
'charges' => 5
]);Ao criar uma transação ou uma assinatura você tem a opção de passar o parâmetro postback_url na requisição. Essa é uma URL do seu sistema que irá então receber notificações a cada alteração de status dessas transações/assinaturas.
Para obter informações sobre postbacks, 3 informações serão necessárias, sendo elas: model, model_id e postback_id.
model: Se refere ao objeto que gerou aquele POSTback. Pode ser preenchido com o valor transaction ou subscription.
model_id: Se refere ao ID do objeto que gerou ao POSTback, ou seja, é o ID da transação ou assinatura que você quer acessar os POSTbacks.
postback_id: Se refere à notificação específica. Para cada mudança de status de uma assinatura ou transação, é gerado um POSTback. Cada POSTback pode ter várias tentativas de entregas, que podem ser identificadas pelo campo deliveries, e o ID dessas tentativas possui o prefixo pd_. O campo que deve ser enviado neste parâmetro é o ID do POSTback, que deve ser identificado pelo prefixo po_.
<?php
$postbacks = $pagarme->postbacks()->getList([
'model' => 'subscription',
'model_id' => 'ID_DA_ASSINATURA'
]);<?php
$postback = $pagarme->postbacks()->get([
'model' => 'transaction',
'model_id' => 'ID_DA_TRANSAÇÃO',
'postback_id' => 'po_cjlzhftd2006xg573fwelfg9y'
]);<?php
$postbackRedeliver = $pagarme->postbacks()->redeliver([
'model' => 'subscription',
'model_id' => 'ID_DA_ASSINATURA',
'postback_id' => 'po_cjlzhftd2006xg573fwelfg9y'
]);<?php
$postbackPayload = file_get_contents('php://input');
$signature = $_SERVER['HTTP_X_HUB_SIGNATURE'];
$postbackIsValid = $pagarme->postbacks()->validate($postbackPayload, $signature);Observação: o código acima serve somente de exemplo para que o processo de validação funcione. Recomendamos que utilize ferramentas fornecidas por bibliotecas ou frameworks para recuperar estas informações de maneira mais adequada.
Para saber o saldo de sua conta, você pode utilizar esse código:
<?php
$balance = $pagarme->balances()->get();Com este objeto você pode acompanhar todas as movimentações financeiras ocorridas em sua conta Pagar.me.
<?php
$balanceOperations = $pagarme->balanceOperations()->getList();Se necessário, você pode passar filtros como parâmetro, por exemplo:
<?php
$balanceOperations = $pagarme->balanceOperations()->getList([
'status' => 'available'
]);<?php
$balanceOperation = $pagarme->balanceOperations()->get([
'id' => 'BALANCE_OPERATION_ID'
]);Objeto contendo os dados de um recebível. O recebível (payable) é gerado automaticamente após uma transação ser paga. Para cada parcela de uma transação é gerado um recebível, que também pode ser dividido por recebedor (no caso de um split ter sido feito).
<?php
$payables = $pagarme->payables()->getList();Se necessário, você pode aplicar filtros na busca dos payables, por exemplo, você pode recuperar todos os payables de uma transação:
<?php
$transactionPayables = $pagarme->payables()->getList([
'transaction_id' => 'ID_DA_TRANSAÇÃO'
]);<?php
$payable = $pagarme->payables()->get([
'id' => 'ID_DO_PAYABLE'
]);Transferências representam os saques de sua conta.
<?php
$transfer = $pagarme->transfers()->create([
'amount' => 1000,
'recipient_id' => 're_cjeptpdyg03u3cb6elj68p5ej'
]);<?php
$transfers = $pagarme->transfers()->getList();Se necessário, você pode aplicar filtros em sua busca, por exemplo:
<?php
$recipientTransfers = $pagarme->transfers()->getList([
'recipient_id' => 'ID_DO_RECEBEDOR'
]);<?php
$transfer = $pagarme->transfers()->get([
'id' => 'ID_DA_TRANSFERÊNCIA'
]);<?php
$canceledTransfer = $pagarme->transfers()->cancel([
'id' => 'ID_DA_TRANSFERÊNCIA'
]);Para entender o que são as antecipações, você deve acessar esse link.
<?php
$anticipation = $pagarme->bulkAnticipations()->create([
'recipient_id' => 're_cjeptpdyg03u3cb6elj68p5ej',
'build' => 'true',
'payment_date' => '1536883200000',
'requested_amount' => '300000',
'timeframe' => 'start'
]);<?php
$anticipationLimits = $pagarme->bulkAnticipations()->getLimits([
'recipient_id' => 'ID_DO_RECEBEDOR',
'payment_date' => '1536883200000',
'timeframe' => 'start'
]);<?php
$confirmedAnticipation = $pagarme->bulkAnticipations()->confirm([
'recipient_id' => 'ID_DO_RECEBEDOR',
'bulk_anticipation_id' => 'ID_DA_ANTECIPAÇÃO',
]);<?php
$canceledAnticipation = $pagarme->bulkAnticipations()->cancel([
'recipient_id' => 'ID_DO_RECEBEDOR',
'bulk_anticipation_id' => 'ID_DA_ANTECIPAÇÃO',
]);<?php
$deletedAnticipation = $pagarme->bulkAnticipations()->delete([
'recipient_id' => 'ID_DO_RECEBEDOR',
'bulk_anticipation_id' => 'ID_DA_ANTECIPAÇÃO',
]);<?php
$anticipations = $pagarme->bulkAnticipations()->getList([
'recipient_id' => 'ID_DO_RECEBEDOR'
]);Se necessário, você pode aplicar filtros nessa busca, por exemplo, pelo valor antecipado:
<?php
$anticipations = $pagarme->bulkAnticipations()->getList([
'recipient_id' => 'ID_DO_RECEBEDOR',
'amount' => 'VALOR_ANTECIPADO'
]);Contas bancárias identificam para onde será enviado o dinheiro de futuros pagamentos.
<?php
$bankAccount = $pagarme->bankAccounts()->create([
'bank_code' => '341',
'agencia' => '0932',
'agencia_dv' => '5',
'conta' => '58054',
'conta_dv' => '1',
'document_number' => '26268738888',
'legal_name' => 'API BANK ACCOUNT'
]);<?php
$bankAccount = $pagarme->bankAccounts()->get([
'id' => 'ID_DA_CONTA_BANCÁRIA'
]);<?php
$bankAccounts = $pagarme->bankAccounts()->getList();Se quiser, você pode aplicar filtros para a busca de contas bancárias, como por exemplo, filtrar pelo código do banco:
<?php
$bankAccounts = $pagarme->bankAccounts()->getList([
'bank_code' => '341'
]);Para dividir uma transação entre várias entidades, é necessário ter um recebedor para cada uma dessas entidades. Recebedores contém informações da conta bancária para onde o dinheiro será enviado, e possuem outras informações para saber quanto pode ser antecipado por ele, ou quando o dinheiro de sua conta será sacado automaticamente.
<?php
$recipient = $pagarme->recipients()->create([
'anticipatable_volume_percentage' => '85',
'automatic_anticipation_enabled' => 'true',
'bank_account_id' => '17899179',
'transfer_day' => '5',
'transfer_enabled' => 'true',
'transfer_interval' => 'weekly'
]);<?php
$recipients = $pagarme->recipients()->getList();Se necessário, você pode aplicar filtros nessa busca. Por exemplo, se quiser retornar todos os recebedores, com transferência habilitada, você pode utilizar esse código:
<?php
$transferEnabledRecipients = $pagarme->recipients()->getList([
'transfer_enabled' => true
]);<?php
$recipient = $pagarme->recipients()->get([
'id' => 'ID_DO_RECEBEDOR'
]);<?php
$updatedRecipient = $pagarme->recipients()->update([
'id' => 'ID_DO_RECEBEDOR',
'anticipatable_volume_percentage' => 80,
'transfer_day' => 4
]);<?php
$recipientBalance = $pagarme->recipients()->getBalance([
'recipient_id' => 'ID_DO_RECEBEDOR',
]);<?php
$recipientBalanceOperations = $pagarme->recipients()->listBalanceOperation([
'recipient_id' => 'ID_DO_RECEBEDOR'
]);<?php
$recipientBalanceOperation = $pagarme->recipients()->getBalanceOperation([
'recipient_id' => 'ID_DO_RECEBEDOR',
'balance_operation_id' => 'ID_DA_OPERAÇÃO'
]);Clientes representam os usuários de sua loja, ou negócio. Este objeto contém informações sobre eles, como nome, e-mail e telefone, além de outros campos.
<?php
$customer = $pagarme->customers()->create([
'external_id' => '#123456789',
'name' => 'João das Neves',
'type' => 'individual',
'country' => 'br',
'email' => '[email protected]',
'documents' => [
[
'type' => 'cpf',
'number' => '11111111111'
]
],
'phone_numbers' => [
'+5511999999999',
'+5511888888888'
],
'birthday' => '1985-01-01'
]);<?php
$customers = $pagarme->customers()->getList();<?php
$customer = $pagarme->customers()->get([
'id' => 'ID_DO_CLIENTE'
]);<?php
$paymentLink = $pagarme->paymentLinks()->create([
'amount' => 10000,
'items' => [
[
'id' => '1',
'title' => "Fighter's Sword",
'unit_price' => 4000,
'quantity' => 1,
'tangible' => true,
'category' => 'weapon',
'venue' => 'A Link To The Past',
'date' => '1991-11-21'
],
[
'id' => '2',
'title' => 'Kokiri Sword',
'unit_price' => 6000,
'quantity' => 1,
'tangible' => true,
'category' => 'weapon',
'venue' => "Majora's Mask",
'date' => '2000-04-27'
],
],
'payment_config' => [
'boleto' => [
'enabled' => true,
'expires_in' => 20
],
'credit_card' => [
'enabled' => true,
'free_installments' => 4,
'interest_rate' => 25,
'max_installments' => 12
],
'default_payment_method' => 'boleto'
],
'max_orders' => 1,
'expires_in' => 60
]);<?php
$paymentLinks = $pagarme->paymentLinks()->getList();<?php
$paymentLink = $pagarme->paymentLinks()->get([
'id' => 'ID_DO_LINK_DE_PAGAMENTO'
]);<?php
$canceledPaymentLink = $pagarme->paymentLinks()->cancel([
'id' => 'ID_DO_LINK_DE_PAGAMENTO'
]);<?php
$search = $pagarme->search()->get([
"type" => "transaction",
"query" => [
"query" => [
"terms" => [
"items.id" => [8, 9] // Busca transações com itens de ID 8 e 9
]
]
]
]);