1. Go to this page and download the library: Download aqbank/aqpago-sdk-api-v2 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/ */
aqbank / aqpago-sdk-api-v2 example snippets
sh
ank\Apiv2\SellerAqpago;
use Aqbank\Apiv2\Aqpago\Request\AqpagoEnvironment;
use Aqbank\Apiv2\Aqpago\Aqpago;
try {
$sellerAqpago = new Aqbank\Apiv2\SellerAqpago(
'00000000000000', // document registered with aqpago
'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' // token registered in the app
);
// Ambiente de produção
$environment = AqpagoEnvironment::production();
// Ambiente de homologação
// $environment = AqpagoEnvironment::sandbox();
$public_token = (new Aqpago($sellerAqpago, $environment))->getPublicToken();
} catch (Exception $e) {
$error = $e->getMessage();
$error = json_decode($error, true);
echo "<h1>";
print_r($error['error']);
echo "</h1>";
exit();
}
sh
bank\Apiv2\SellerAqpago;
use Aqbank\Apiv2\Aqpago\Request\AqpagoEnvironment;
use Aqbank\Apiv2\Aqpago\Aqpago;
use Aqbank\Apiv2\Aqpago\Order;
$seller_doc = '0000000000';
$seller_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$sellerAqpago = new SellerAqpago($seller_doc, $seller_token);
// Ambiente de homologação
$environment = AqpagoEnvironment::sandbox();
/**
* aqpago_session_id
*
* see how to get the session in getSessionId.php
*/
$aqpago_session_id = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
$order = new Order($aqpago_session_id);
try {
$order->setReferenceId( 'reference_id')
->setAmount('100.00')
->setType('credit'); // credit, multi_credit, multi_ticket, ticket
// setAmount deve ser igual ao total da soma dos itens + frete, o frete não é obrigatório.
$customer = $order->customer();
$customer->setName('Name')
->setEmail('[email protected]')
->setTaxDocument('00000000000');
$customer->address()
->setPostCode('00000000')
->setStreet('Endereço')
->setNumber('Numero')
->setComplement('Complemento')
->setDistrict('Bairro')
->setCity('Cidade')
->setState('UF');
$customer->phones()
->setArea('11')
->setNumber('912341234');
// Frete opcional
$order->shipping('0.00', 'Frete grátis');
$order->items()
->setName('Meu item')
->setQty(1)
->setUnitAmount(50.00);
// (Unit Amount * Qty) será o total do item
//para enviar mais itens no objeto repetir até que todos os itens sejam declarados
// lembre-se que setAmount deve ser igual a soma dos itens mais o frete
$order->items()
->setName('Segundo item')
->setQty(1)
->setUnitAmount(50.00);
// creditCard('valor total', 'parcelas')
$order->creditCard('100.00', 1)
->setCardNumber('0000000000000000')
->setHolderName('Fulano de tal')
->setExpirationMonth('02')
->setExpirationYear('2023')
->setSecurityCode('123')
->setCpf('00000000000');
$aqpago = (new Aqpago($sellerAqpago, $environment))->createOrder($order);
} catch(Exception $e){
echo $e->getMessage();
exit();
}
echo "<h2>Request: </h2>";
echo "<pre>";
echo json_encode(array_filter($order->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
echo "<br>";
echo "<h2>Response: </h2>";
echo "<pre>";
echo json_encode(array_filter($aqpago->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
sh
der->setReferenceId( 'reference_id')
->setAmount('100.00')
->setType('ticket'); // Pagamento com boleto
...
// Pagamento por Boleto
$order->ticket('100.00')
->setBodyInstructions('Linha de instruções');
...
sh
der->setReferenceId( 'reference_id')
->setAmount('100.00')
->setType('multi_credit'); // 2 cartões de Crédito
...
// 1 primeiro cartão
$order->creditCard('50.00', 1)
->setCardNumber('0000000000000000')
->setHolderName('Fulano de tal')
->setExpirationMonth('02')
->setExpirationYear('2023')
->setSecurityCode('123')
->setCpf('00000000000');
// 2 segundo cartão
$order->creditCard('50.00', 1)
->setCardNumber('0000000000000000')
->setHolderName('Fulano de tal')
->setExpirationMonth('02')
->setExpirationYear('2023')
->setSecurityCode('123')
->setCpf('00000000000');
...
$aqpago = (new Aqpago($sellerAqpago, $environment))->createOrder($order);
...
sh
rder->setReferenceId( 'reference_id')
->setAmount('100.00')
->setType('multi_ticket'); // cartão e boleto
...
// Meio Cartão de crédito
$order->creditCard('50.00', 1)
->setCardNumber('0000000000000000')
->setHolderName('Fulano de tal')
->setExpirationMonth('02')
->setExpirationYear('2023')
->setSecurityCode('123')
->setCpf('00000000000');
// Meio Boleto
$order->ticket('50.00')
->setBodyInstructions('Linha de instruções');
...
sh
bank\Apiv2\SellerAqpago;
use Aqbank\Apiv2\Aqpago\Request\AqpagoEnvironment;
use Aqbank\Apiv2\Aqpago\Webhook;
use Aqbank\Apiv2\Aqpago\Aqpago;
$urlWebhook = 'https://xxxxxxxxxxxxx.com.br/webhook';
// Url que api enviara o webhook
$description = 'Minha loja'; // uma breve descrição
$events = [
"transation.success",
"transaction.succeeded",
"transaction.reversed",
"transaction.failed",
"transaction.canceled",
"transaction.disputed",
"transaction.charged_back",
"transaction.pre_authorized"
];
try {
$webhook = new Webhook();
$webhook->setEvent($events)
->setUrl($urlWebhook)
->setDescription($description)
->setMethod('POST');
// Configure o ambiente
// Ambiente de homologação
$environment = AqpagoEnvironment::sandbox();
// Ambiente de produção
//$environment = AqpagoEnvironment::production();
$seller_doc = '0000000000';
$seller_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$sellerAqpago = new SellerAqpago($seller_doc, $seller_token);
$aqpago = (new Aqpago($sellerAqpago, $environment))->createWebhook($webhook);
} catch(Exception $e){
echo $e->getMessage();
exit();
}
echo "<br>";
echo "<h2>Response: </h2>";
echo "<pre>";
echo json_encode(array_filter($aqpago->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
sh
bank\Apiv2\SellerAqpago;
use Aqbank\Apiv2\Aqpago\Request\AqpagoEnvironment;
use Aqbank\Apiv2\Aqpago\Aqpago;
use Aqbank\Apiv2\Aqpago\Order;
try {
// Ambiente de homologação
$environment = AqpagoEnvironment::sandbox();
$seller_doc = '0000000000';
$seller_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$sellerAqpago = new SellerAqpago($seller_doc, $seller_token);
/** Pesquisa por ORDER ID **/
$searchOrderId = (new Aqpago($sellerAqpago, $environment))->getOrder('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX');
/** Pesquisa geral, retorna todos os pedidos **/
$allOrders = (new Aqpago($sellerAqpago, $environment))->getSearchOrders();
/*** Pesquisa com filtros **/
$filters = [
'reference_id' => null, // reference id
'status' => null, // order status
'type' => null, // type
'amount' => null, // amount
'initial_date' => null, // start date
'final_date' => null, // end date
'limit' => null, // limit per page
'page' => null, // page number
'sort' => null // asc or desc
];
$filterOrders = (new Aqpago($sellerAqpago, $environment))->getSearchOrders($filters);
} catch(Exception $e){
echo $e->getMessage();
exit();
}
echo "<br>";
echo "<h2>Response order ID: </h2>";
echo "<pre>";
echo json_encode(array_filter($searchOrderId->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
echo "<br>";
echo "<h2>Response all orders: </h2>";
echo "<pre>";
echo json_encode(array_filter($allOrders->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
echo "<br>";
echo "<h2>Response filter orders: </h2>";
echo "<pre>";
echo json_encode(array_filter($filterOrders->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
sh
bank\Apiv2\SellerAqpago;
use Aqbank\Apiv2\Aqpago\Request\AqpagoEnvironment;
use Aqbank\Apiv2\Aqpago\Aqpago;
use Aqbank\Apiv2\Aqpago\Order;
try {
// Ambiente de homologação
$environment = AqpagoEnvironment::sandbox();
$seller_doc = '0000000000';
$seller_token = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX';
$sellerAqpago = new SellerAqpago($seller_doc, $seller_token);
$order = new Order();
$order->setOrderId('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX');
$response = (new Aqpago($sellerAqpago, $environment))->cancelOrder($order);
// Os pedidos só podem ser cancelados pela API no mesmo dia.
} catch(Exception $e){
echo $e->getMessage();
exit();
}
echo "<br>";
echo "<h2>Response cancel order: </h2>";
echo "<pre>";
echo json_encode(array_filter($response->jsonSerialize()), JSON_PRETTY_PRINT);
echo "</pre>";
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.