PHPackages aqbank/aqpago-sdk-api-v2 - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. aqbank/aqpago-sdk-api-v2 ActiveLibrary[API Development](/categories/api) aqbank/aqpago-sdk-api-v2 ======================== SDK for PHP with AQBank 1.3.3(1y ago)042711MITPHPPHP >=5.6 Since Feb 1Pushed 1y ago1 watchersCompare [ Source](https://github.com/aqbank/aqpago-sdk-api-v2)[ Packagist](https://packagist.org/packages/aqbank/aqpago-sdk-api-v2)[ Docs](https://aqpago.com.br)[ RSS](/packages/aqbank-aqpago-sdk-api-v2/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (8)Dependencies (1)Versions (9)Used By (1) SDK para integrar com a AQPago ============================== [](#sdk-para-integrar-com-a-aqpago) ### Descrição [](#descrição) SDK em PHP para integração com meio de pagamento AQPAgo. Você pode oferecer os seguintes meios de pagamentos da AQPago: - Pagamento com cartão de crédito. - Pagamento múltiplo com dois cartões. - Pagamento múltiplo com cartão e boleto. - Pagamento com boleto. Instalação via composer ----------------------- [](#instalação-via-composer) - `composer require aqbank/aqpago-sdk-api-v2` Documentação da API ------------------- [](#documentação-da-api) - [API AQPago](https://apideveloper.aqpago.com.br) ### Dados de Autenticação e ambiente [](#dados-de-autenticação-e-ambiente) ``` getPublicToken(); } catch (Exception $e) { $error = $e->getMessage(); $error = json_decode($error, true); echo ""; print_r($error['error']); echo ""; exit(); } ?> Page Checkout Load Session ID window.addEventListener("load", function(){ AQPAGOSECTION.setPublicToken(''); }); function showSessionId() { if (AQPAGOSECTION.getSessionID() != null) { alert( 'APago SessionId: ' + AQPAGOSECTION.getSessionID() ) } else { /** * waiting to generate session id */ setTimeout(() => { return showSessionId(); }, 500); } } Get a session id at your checkout when loading the page. Alert my Session ID AQPago ``` ### Criar novo pedido com cartão [](#criar-novo-pedido-com-cartão) ``` 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('exemple@exemple.com.br') ->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 "Request: "; echo ""; echo json_encode(array_filter($order->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; echo ""; echo "Response: "; echo ""; echo json_encode(array_filter($aqpago->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; ``` ### Pagamento com Boleto [](#pagamento-com-boleto) ``` setReferenceId( 'reference_id') ->setAmount('100.00') ->setType('ticket'); // Pagamento com boleto ... // Pagamento por Boleto $order->ticket('100.00') ->setBodyInstructions('Linha de instruções'); ... ``` ### Pagamento com 2 Cartões de Crédito [](#pagamento-com-2-cartões-de-crédito) ``` 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); ... ``` ### Pagamento com Cartão e Boleto [](#pagamento-com-cartão-e-boleto) ``` 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'); ... ``` ### Cadastrar url para receber Webhook [](#cadastrar-url-para-receber-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 ""; echo "Response: "; echo ""; echo json_encode(array_filter($aqpago->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; ``` ### Consultar Pedidos [](#consultar-pedidos) ``` 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 ""; echo "Response order ID: "; echo ""; echo json_encode(array_filter($searchOrderId->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; echo ""; echo "Response all orders: "; echo ""; echo json_encode(array_filter($allOrders->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; echo ""; echo "Response filter orders: "; echo ""; echo json_encode(array_filter($filterOrders->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; ``` ### Cancelar Pedido [](#cancelar-pedido) ``` 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 ""; echo "Response cancel order: "; echo ""; echo json_encode(array_filter($response->jsonSerialize()), JSON_PRETTY_PRINT); echo ""; ``` ### Health Score 29 — LowBetter than 60% of packages Maintenance33 Infrequent updates — may be unmaintained Popularity13 Limited adoption so far Community15 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 89.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~128 days Recently: every ~147 days Total 8 Last Release 664d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/d920e3d6f61e70b8995a3d2999baac55297220bee152584858c39be1cb5379e7?d=identicon)[RafaelCarmoAqbank](/maintainers/RafaelCarmoAqbank) ![](https://www.gravatar.com/avatar/1959626d14fb9359bfed348d1d5eacd8442ea6fa66e137fe76e7d4ef43972529?d=identicon)[aqbank](/maintainers/aqbank) --- Top Contributors [![rafael-max-aqbank](https://avatars.githubusercontent.com/u/95052560?v=4)](https://github.com/rafael-max-aqbank "rafael-max-aqbank (49 commits)")[![Richar9191](https://avatars.githubusercontent.com/u/174037000?v=4)](https://github.com/Richar9191 "Richar9191 (5 commits)")[![aqbank](https://avatars.githubusercontent.com/u/72698509?v=4)](https://github.com/aqbank "aqbank (1 commits)") ### Embed Badge ![Health badge](/badges/aqbank-aqpago-sdk-api-v2/health.svg) ``` [![Health](https://phpackages.com/badges/aqbank-aqpago-sdk-api-v2/health.svg)](https://phpackages.com/packages/aqbank-aqpago-sdk-api-v2) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M651](/packages/sylius-sylius)[algolia/algoliasearch-client-php API powering the features of Algolia. 69333.0M114](/packages/algolia-algoliasearch-client-php)[theodo-group/llphant LLPhant is a library to help you build Generative AI applications. 1.5k311.5k5](/packages/theodo-group-llphant)[wheelpros/fitment-platform-api Magento 2 (Open Source) 12.1k1.2k](/packages/wheelpros-fitment-platform-api)[avalara/avataxclient Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API. 517.9M7](/packages/avalara-avataxclient)[alexacrm/dynamics-webapi-toolkit Web API toolkit for Microsoft Dynamics 365 and Dynamics CRM 81324.1k1](/packages/alexacrm-dynamics-webapi-toolkit) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)