PHP code example of devsitarget / sdk-pagarme-php

1. Go to this page and download the library: Download devsitarget/sdk-pagarme-php library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.
    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

devsitarget / sdk-pagarme-php example snippets




use PagarmeSdk\Environment;
use PagarmeSdk\Pagarme;
use PagarmeSdk\Store;

$store = new Store(
    apiKey: 'SUA_SECRET_KEY',
    environment: Environment::sandbox()
);

$pagarme = new Pagarme($store);



use PagarmeSdk\Address;
use PagarmeSdk\Customer;

$customer = new Customer(
    id: '123',
    name: 'Cliente',
    email: '[email protected]',
    document: '12345678900',
    phone: '11999999999',
    address: new Address(
        street: 'Rua A',
        number: '100',
        zipCode: '01234567',
        neighborhood: 'Centro',
        city: 'Sao Paulo',
        state: 'SP'
    )
);



use PagarmeSdk\Pix\PixRequest;

$pixResponse = $pagarme->createPixCharge(new PixRequest(
    amount: 120.50,
    currency: 'BRL',
    customer: $customer,
    description: 'Pedido 123',
    number: '123',
    metadata: [
        'expires_in' => 3600,
    ]
));

echo $pixResponse->pixCopyPaste;



use PagarmeSdk\CreditCard\CreditCard;
use PagarmeSdk\CreditCard\CreditCardRequest;

$cardResponse = $pagarme->createCreditCardPayment(new CreditCardRequest(
    amount: 150.00,
    currency: 'BRL',
    customer: $customer,
    creditCard: new CreditCard(
        number: '4111111111111111',
        holderName: 'Cliente Teste',
        expirationMonth: '12',
        expirationYear: '2030',
        securityCode: '123'
    ),
    installments: 3,
    description: 'Pedido 123',
    number: '123'
));

echo $cardResponse->status->value;



use DateTime;
use PagarmeSdk\Bank\BankRequest;

$bankResponse = $pagarme->generateBank(new BankRequest(
    amount: 100.00,
    currency: 'BRL',
    customer: $customer,
    description: 'Pedido 123',
    dueDate: new DateTime('2026-03-10'),
    number: '123'
));

echo $bankResponse->url;



// Aceita orderId (or_...) ou chargeId (ch_...)
$order = $pagarme->getTransactionById('or_123');
$status = $pagarme->checkPaymentStatus('ch_123');
$bankData = $pagarme->getBankData('ch_123');
$pixData = $pagarme->checkPixStatus('ch_123');
$pixPayload = $pagarme->getPixPayload('or_123');



$parsed = Pagarme::parseSettlementWebhook($payload);

// Campos principais:
// tid, transactionId, tokenTransaction, paymentMethodCode,
// statusCode, lowDate, occurrenceDate, authorizationCode, nsu



use PagarmeSdk\BillAffiliate;
use PagarmeSdk\Pix\PixRequest;

$pixResponse = $pagarme->createPixCharge(new PixRequest(
    amount: 120.50,
    currency: 'BRL',
    customer: $customer,
    description: 'Pedido com split',
    number: '123',
    affiliates: [
        new BillAffiliate(recipientId: 'rp_123', percentage: 50),
        new BillAffiliate(recipientId: 'rp_456', commissionAmount: 10.00),
    ]
));
bash
composer