PHPackages paygo-dev/paygo-sdk-php - 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. paygo-dev/paygo-sdk-php ActiveLibraries[API Development](/categories/api) paygo-dev/paygo-sdk-php ======================= Cliente em PHP para integração com as APIs de consulta de transações 0.1.2(7y ago)21.4kPHPPHP >=5.6 Since Oct 19Pushed 7y ago2 watchersCompare [ Source](https://github.com/paygo-dev/paygo-sdk-php)[ Packagist](https://packagist.org/packages/paygo-dev/paygo-sdk-php)[ RSS](/packages/paygo-dev-paygo-sdk-php/feed)WikiDiscussions master Synced 3d ago READMEChangelogDependencies (2)Versions (4)Used By (0) PayGo WEB client SDK ==================== [](#paygo-web-client-sdk) [![Build Status](https://camo.githubusercontent.com/9cea686155ec7280ac820bead6882a0f7684368d18f8540fccc847164da191cc/68747470733a2f2f7472617669732d63692e636f6d2f706179676f2d6465762f706179676f2d73646b2d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/paygo-dev/paygo-sdk-php)[![Code Climate](https://camo.githubusercontent.com/af39b9f13fee2ed97f58db550989583a3de859ae4f96d65202ee4f31e20a9243/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f706179676f2d6465762f706179676f2d73646b2d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/paygo-dev/paygo-sdk-php)[![Scrutinizer Code Quality](https://camo.githubusercontent.com/23ec820d1c726fc1fd28a693bc5366560a8ef9f0ed000a776db4713fee5034f0/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f706179676f2d6465762f706179676f2d73646b2d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/paygo-dev/paygo-sdk-php/?branch=master)[![Code Coverage](https://camo.githubusercontent.com/b238c8f7d71ea18b5e4b2d38b36eeb832c80a4c4e0ebc5675e96168dcde46a1d/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f706179676f2d6465762f706179676f2d73646b2d7068702f6261646765732f636f7665726167652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/paygo-dev/paygo-sdk-php/?branch=master) [![Total Downloads](https://camo.githubusercontent.com/65bb3e5bab8775fd2edab859aa42dd18a1dd8098596d2020d00b65fa3a7b4316/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f646f776e6c6f616473)](https://packagist.org/packages/paygo-dev/paygo-sdk-php)[![Monthly Downloads](https://camo.githubusercontent.com/b0892bd8e9a3ebad8f86735bc28168244db0b247ad9389ca27497c832490918f/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f642f6d6f6e74686c79)](https://packagist.org/packages/paygo-dev/paygo-sdk-php)[![Daily Downloads](https://camo.githubusercontent.com/090ed15700feb926f86a7ac17293649c20a064345613c0b8da1eca27950bfd46/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f642f6461696c79)](https://packagist.org/packages/paygo-dev/paygo-sdk-php) [![Latest Stable Version](https://camo.githubusercontent.com/99820ba6b58027702dec9921388e59cd0c2d0ac82d268f4f221012813f653deb/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f762f737461626c65)](https://packagist.org/packages/paygo-dev/paygo-sdk-php)[![Latest Unstable Version](https://camo.githubusercontent.com/3b456d8c8b4942412f727ab0c9b79db6bdae77671990bb8582e2b9b7d4aa7feb/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f762f756e737461626c65)](https://packagist.org/packages/paygo-dev/paygo-sdk-php)[![License](https://camo.githubusercontent.com/9d8ef4f50d55470b04d4cd708eeb42707801439b8288b6f0a52f1af3fc06c17b/68747470733a2f2f706f7365722e707567782e6f72672f706179676f2d6465762f706179676f2d73646b2d7068702f6c6963656e7365)](https://packagist.org/packages/paygo-dev/paygo-sdk-php) Dependências ------------ [](#dependências) #### require [](#require) - PHP >= 5.6 - guzzlehttp/guzzle 5.3.1 #### require-dev [](#require-dev) - phpunit/phpunit ^4.8 Instalação ---------- [](#instalação) Execute em seu shell: ``` composer require paygo-dev/paygo-sdk-php ``` Adicionando a dependência ao seu arquivo composer.json ``` { "require": { "paygo-dev/paygo-sdk-php" : "*" } } ``` Variáveis de ambiente --------------------- [](#variáveis-de-ambiente) ``` PAYGO_TRANSACTIONS_HOST=http://api.paygomais.com.br PAYGO_TRANSACTIONS_TIMEOUT=10 PAYGO_TRANSACTIONS_TOKEN=e258c0g0-4795-4bf3-bf12-483737e9cac3 ``` Configurando a autenticação --------------------------- [](#configurando-a-autenticação) ### Informar parâmetros de integração [](#informar-parâmetros-de-integração) Para que o SDK consiga acessar as API's é necessário informar os parâmetros conforme exemplo abaixo, caso não seja específicado o SDK irá aferir através de variáveis de ambiente. ``` $client = new \PayGo\Client([ 'PAYGO_TRANSACTIONS_HOST' => "http://api.paygomais.com.br", 'PAYGO_TRANSACTIONS_TIMEOUT' => 10, 'PAYGO_TRANSACTIONS_TOKEN' => "e258c0g0-4795-4bf3-bf12-483737e9cac3", ]); $transactionApi = new \PayGo\Transactions\API\TransactionAPI($client); ``` Os parâmetros poder ser definidos ou alterados conforme abaixo. ``` $client = (new Client()) ->setParameter('PAYGO_TRANSACTIONS_HOST', "http://api.paygomais.com.br") ->setParameter('PAYGO_TRANSACTIONS_TIMEOUT', 10) ->setParameter('PAYGO_TRANSACTIONS_TOKEN', "e258c0g0-4795-4bf3-bf12-483737e9cac3"); $transactionApi = new \PayGo\Transactions\API\TransactionAPI($client); ``` Caso os parâmetros não sejam informados o SDK irá aferir através de variáveis de ambiente caso tenha sido configuradas ``` $transactionApi = new \PayGo\Transactions\API\TransactionAPI(); ``` ### Exemplos de utilização [](#exemplos-de-utilização) Exemplo de consulta por intervalo de data, retornando apenas um registro. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setFilters( (new \PayGo\Transactions\Contracts\Query\Filters()) ->setServerDateRange( (new \PayGo\Transactions\Contracts\Query\DateRange()) ->setFromDate(\DateTime::createFromFormat('Y-m-d', '2015-01-01')) ->setEndDate(\DateTime::createFromFormat('Y-m-d', '2018-12-01')) ) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(27) { ["AffiliationCompanyDataDisplayName"]=> string(4) "TESTE" ["AffiliationCompanyDataTaxId"]=> string(18) "99.999.999/0001-99" ["AffiliationNumber"]=> string(32) "********************************" ["Amount"]=> string(4) "5000" ["AuthorizerCode"]=> string(5) "STONE" ["AuthorizerExternalReference"]=> string(14) "19291241077475" ["AuthorizerName"]=> string(5) "STONE" ["CardDataCardName"]=> string(10) "MASTERCARD" ["CardDataExpirationDate"]=> string(4) "2602" ["CardDataMaskedCardNumber"]=> string(16) "************5768" ["CardDataType"]=> int(1) ["FinancingDataInstallmentsNumber"]=> int(1) ["FinancingDataType"]=> int(1) ["FullReceiptCopy"]=> string(543) " STONE - VIA ESTABELECIMENTO MASTERCARD - CREDITO A VISTA CNPJ: 999.999.999/0001-99 2ALL BELO HORIZONTE - MG ************5766 02/04/18 16:42 EC:128268623 AUT:424973 SAK:&E62D11B67204181A190D83E1EBED4EC DOC:1585 STONE ID:19281241077495 AC:6B087A3450022121 ONL-CHIP AID: A0000000041010 Credito APROVADO TOTAL: R$ 50,00 TRANSACAO APROVADA COM SENHA ---------------------------------------- 71666 0000007544 0000002585 " ["InternalLocalReference"]=> int(1585) ["POSCompanyDataDisplayName"]=> string(27) "Adriano M. La Selva" ["POSCompanyDataTaxId"]=> string(14) "111.111.111-11" ["POSDataDescription"]=> string(12) "Door to Door" ["POSDataIdentifier"]=> string(5) "9999999" ["POSTimestamp"]=> string(19) "2018-04-02 16:43:04" ["ProductName"]=> string(15) "CREDITO A VISTA" ["Result"]=> int(0) ["ResultMessage"]=> string(9) "APROVADO " ["ServerTimestamp"]=> string(19) "2018-04-02 16:42:46" ["Status"]=> string(3) "289" ["Type"]=> int(33) ["UniqueId"]=> int(33171163) } } ``` Exemplo de consulta por intervalo de data e tipos de transações, retornando apenas um registro. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setFilters( (new \PayGo\Transactions\Contracts\Query\Filters()) ->setTypes([1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,33,34]) ->setServerDateRange( (new \PayGo\Transactions\Contracts\Query\DateRange()) ->setFromDate(\DateTime::createFromFormat('Y-m-d', '2015-01-01')) ->setEndDate(\DateTime::createFromFormat('Y-m-d', '2018-12-01')) ) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(27) { ["AffiliationCompanyDataDisplayName"]=> string(4) "TESTE" ["AffiliationCompanyDataTaxId"]=> string(18) "99.999.999/0001-99" ["AffiliationNumber"]=> string(32) "********************************" ["Amount"]=> string(4) "5000" ["AuthorizerCode"]=> string(5) "STONE" ["AuthorizerExternalReference"]=> string(14) "19291241077475" ["AuthorizerName"]=> string(5) "STONE" ["CardDataCardName"]=> string(10) "MASTERCARD" ["CardDataExpirationDate"]=> string(4) "2602" ["CardDataMaskedCardNumber"]=> string(16) "************5768" ["CardDataType"]=> int(1) ["FinancingDataInstallmentsNumber"]=> int(1) ["FinancingDataType"]=> int(1) ["FullReceiptCopy"]=> string(543) " STONE - VIA ESTABELECIMENTO MASTERCARD - CREDITO A VISTA CNPJ: 999.999.999/0001-99 2ALL BELO HORIZONTE - MG ************5766 02/04/18 16:42 EC:128268623 AUT:424973 SAK:&E62D11B67204181A190D83E1EBED4EC DOC:1585 STONE ID:19281241077495 AC:6B087A3450022121 ONL-CHIP AID: A0000000041010 Credito APROVADO TOTAL: R$ 50,00 TRANSACAO APROVADA COM SENHA ---------------------------------------- 71666 0000007544 0000002585 " ["InternalLocalReference"]=> int(1585) ["POSCompanyDataDisplayName"]=> string(27) "Adriano M. La Selva" ["POSCompanyDataTaxId"]=> string(14) "111.111.111-11" ["POSDataDescription"]=> string(12) "Door to Door" ["POSDataIdentifier"]=> string(5) "9999999" ["POSTimestamp"]=> string(19) "2018-04-02 16:43:04" ["ProductName"]=> string(15) "CREDITO A VISTA" ["Result"]=> int(0) ["ResultMessage"]=> string(9) "APROVADO " ["ServerTimestamp"]=> string(19) "2018-04-02 16:42:46" ["Status"]=> string(3) "289" ["Type"]=> int(33) ["UniqueId"]=> int(33171163) } } ``` Exemplo de consulta por intervalo de data e status de transações, retornando apenas um registro. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setFilters( (new \PayGo\Transactions\Contracts\Query\Filters()) ->setStatus([289,8737]) ->setServerDateRange( (new \PayGo\Transactions\Contracts\Query\DateRange()) ->setFromDate(\DateTime::createFromFormat('Y-m-d', '2015-01-01')) ->setEndDate(\DateTime::createFromFormat('Y-m-d', '2018-12-01')) ) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(27) { ["AffiliationCompanyDataDisplayName"]=> string(4) "TESTE" ["AffiliationCompanyDataTaxId"]=> string(18) "99.999.999/0001-99" ["AffiliationNumber"]=> string(32) "********************************" ["Amount"]=> string(4) "5000" ["AuthorizerCode"]=> string(5) "STONE" ["AuthorizerExternalReference"]=> string(14) "19291241077475" ["AuthorizerName"]=> string(5) "STONE" ["CardDataCardName"]=> string(10) "MASTERCARD" ["CardDataExpirationDate"]=> string(4) "2602" ["CardDataMaskedCardNumber"]=> string(16) "************5768" ["CardDataType"]=> int(1) ["FinancingDataInstallmentsNumber"]=> int(1) ["FinancingDataType"]=> int(1) ["FullReceiptCopy"]=> string(543) " STONE - VIA ESTABELECIMENTO MASTERCARD - CREDITO A VISTA CNPJ: 999.999.999/0001-99 2ALL BELO HORIZONTE - MG ************5766 02/04/18 16:42 EC:128268623 AUT:424973 SAK:&E62D11B67204181A190D83E1EBED4EC DOC:1585 STONE ID:19281241077495 AC:6B087A3450022121 ONL-CHIP AID: A0000000041010 Credito APROVADO TOTAL: R$ 50,00 TRANSACAO APROVADA COM SENHA ---------------------------------------- 71666 0000007544 0000002585 " ["InternalLocalReference"]=> int(1585) ["POSCompanyDataDisplayName"]=> string(27) "Adriano M. La Selva" ["POSCompanyDataTaxId"]=> string(14) "111.111.111-11" ["POSDataDescription"]=> string(12) "Door to Door" ["POSDataIdentifier"]=> string(5) "9999999" ["POSTimestamp"]=> string(19) "2018-04-02 16:43:04" ["ProductName"]=> string(15) "CREDITO A VISTA" ["Result"]=> int(0) ["ResultMessage"]=> string(9) "APROVADO " ["ServerTimestamp"]=> string(19) "2018-04-02 16:42:46" ["Status"]=> string(3) "289" ["Type"]=> int(33) ["UniqueId"]=> int(33171163) } } ``` Exemplo de consulta omitindo alguns campos do retorno. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setSource( (new \PayGo\Transactions\Contracts\Query\Source()) ->setExclude([ SourceConst::AFFILIATION_COMPANY_DATA_TAX_ID, SourceConst::FULL_RECEIPT_COPY, SourceConst::AFFILIATION_COMPANY_DATA_DISPLAY_NAME ]) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(27) { ["AffiliationNumber"]=> string(32) "********************************" ["Amount"]=> string(4) "5000" ["AuthorizerCode"]=> string(5) "STONE" ["AuthorizerExternalReference"]=> string(14) "19291241077475" ["AuthorizerName"]=> string(5) "STONE" ["CardDataCardName"]=> string(10) "MASTERCARD" ["CardDataExpirationDate"]=> string(4) "2602" ["CardDataMaskedCardNumber"]=> string(16) "************5768" ["CardDataType"]=> int(1) ["FinancingDataInstallmentsNumber"]=> int(1) ["FinancingDataType"]=> int(1) ["InternalLocalReference"]=> int(1585) ["POSCompanyDataDisplayName"]=> string(27) "Adriano M. La Selva" ["POSCompanyDataTaxId"]=> string(14) "111.111.111-11" ["POSDataDescription"]=> string(12) "Door to Door" ["POSDataIdentifier"]=> string(5) "9999999" ["POSTimestamp"]=> string(19) "2018-04-02 16:43:04" ["ProductName"]=> string(15) "CREDITO A VISTA" ["Result"]=> int(0) ["ResultMessage"]=> string(9) "APROVADO " ["ServerTimestamp"]=> string(19) "2018-04-02 16:42:46" ["Status"]=> string(3) "289" ["Type"]=> int(33) ["UniqueId"]=> int(33171163) } } ``` Exemplo de consulta expecificando alguns campos do retorno. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setSource( (new \PayGo\Transactions\Contracts\Query\Source()) ->setInclude([ SourceConst::AFFILIATION_COMPANY_DATA_TAX_ID, SourceConst::FULL_RECEIPT_COPY, SourceConst::AFFILIATION_COMPANY_DATA_DISPLAY_NAME ]) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(4) { ["AffiliationCompanyDataDisplayName"]=> string(4) "Teste" ["AffiliationCompanyDataTaxId"]=> string(18) "999.999.999/0001-99" ["FullReceiptCopy"]=> string(543) " STONE - VIA ESTABELECIMENTO MASTERCARD - CREDITO A VISTA CNPJ: 999.999.999/0001-99 2ALL BELO HORIZONTE - MG ************5766 02/04/18 16:42 EC:128268623 AUT:424973 SAK:&E62D11B67204181A190D83E1EBED4EC DOC:1585 STONE ID:19281241077495 AC:6B087A3450022121 ONL-CHIP AID: A0000000041010 Credito APROVADO TOTAL: R$ 50,00 TRANSACAO APROVADA COM SENHA ---------------------------------------- 71666 0000007544 0000002585 " ["Result"]=> int(0) } } ``` Exemplo de consulta expecificando alguns campos do retorno e fintrando por nome da rede adquirente. ``` $response = $transactionApi->filter( (new \PayGo\Transactions\Contracts\Query\Query()) ->setLimit(1) ->setFilters( (new Filters()) ->setAuthorizerNames(["REDE"]) ) ->setSource( (new \PayGo\Transactions\Contracts\Query\Source()) ->setInclude([ SourceConst::AFFILIATION_COMPANY_DATA_TAX_ID, SourceConst::FULL_RECEIPT_COPY, SourceConst::AFFILIATION_COMPANY_DATA_DISPLAY_NAME, SourceConst::AUTHORIZER_NAME, ]) ) ); print_r($response->getStatusCode()); print_r($response->json()); ``` Resposta ``` array(1) { [0]=> array(4) { ["AffiliationCompanyDataDisplayName"]=> string(4) "Teste" ["AuthorizerName"]=> string(5) "REDE" ["AffiliationCompanyDataTaxId"]=> string(18) "999.999.999/0001-99" ["FullReceiptCopy"]=> string(543) " STONE - VIA ESTABELECIMENTO MASTERCARD - CREDITO A VISTA CNPJ: 999.999.999/0001-99 TESTE BELO HORIZONTE - MG ************5766 02/04/18 16:42 EC:128268623 AUT:424973 SAK:&E62D11B67204181A190D83E1EBED4EC DOC:1585 STONE ID:19281241077495 AC:6B087A3450022121 ONL-CHIP AID: A0000000041010 Credito APROVADO TOTAL: R$ 50,00 TRANSACAO APROVADA COM SENHA ---------------------------------------- 71666 0000007544 0000002585 " ["Result"]=> int(0) } } ``` Licença ------- [](#licença) [The MIT License](https://github.com/paygo-dev/paygo-sdk-php/blob/master/LICENSE) ### Health Score 26 — LowBetter than 43% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community8 Small or concentrated contributor base Maturity49 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% 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 ~24 days Total 3 Last Release 2716d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/2234410?v=4)[Adriano Moreira La Selva](/maintainers/adrianolaselva)[@adrianolaselva](https://github.com/adrianolaselva) --- Top Contributors [![adrianolaselva](https://avatars.githubusercontent.com/u/2234410?v=4)](https://github.com/adrianolaselva "adrianolaselva (2 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/paygo-dev-paygo-sdk-php/health.svg) ``` [![Health](https://phpackages.com/badges/paygo-dev-paygo-sdk-php/health.svg)](https://phpackages.com/packages/paygo-dev-paygo-sdk-php) ``` ### Alternatives [tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi Kit PHP SDK for the Kit API 2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk Rest Client SDK for hydra API 1125.9k2](/packages/mapado-rest-client-sdk) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)