PHPackages ewertondaniel/picpay-e-commerce-php-sdk - 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. [Payment Processing](/categories/payments) 4. / 5. ewertondaniel/picpay-e-commerce-php-sdk ActiveLibrary[Payment Processing](/categories/payments) ewertondaniel/picpay-e-commerce-php-sdk ======================================= PicPay E-Commerce PHP SDK: PHP library provides developers with a simple set of bindings to help you integrate Brazilian to the Payment App PicPay E-Commerce API to a website and start receiving payments. v1.0.7(3y ago)427MITPHPPHP >=8.1 Since Dec 4Pushed 2y ago1 watchersCompare [ Source](https://github.com/EwertonDaniel/picpay-e-commerce-php-sdk)[ Packagist](https://packagist.org/packages/ewertondaniel/picpay-e-commerce-php-sdk)[ Docs](https://github.com/EwertonDaniel/picpay-e-commerce-php-sdk)[ RSS](/packages/ewertondaniel-picpay-e-commerce-php-sdk/feed)WikiDiscussions ewerton Synced 1mo ago READMEChangelog (2)Dependencies (3)Versions (3)Used By (0) [![Generic badge](https://camo.githubusercontent.com/7cc9a50015ad6a1a05098c2c216f335ec40b18bc744892b219631af6aaaa5da6/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6173742d636f6d6d69742f65776572746f6e64616e69656c2f7069637061792d652d636f6d6d657263652d7068702d73646b)](https://github.com/EwertonDaniel/picpay-e-commerce-php-sdk)[![Generic badge](https://camo.githubusercontent.com/3455c656aa71148a4bb8b112eed11bfa3c9dd0ce5c4942001b4cf6851092e427/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f737461626c652d76312e302e372d626c75652e737667)](https://github.com/EwertonDaniel/picpay-e-commerce-php-sdk)[![GitHub license](https://camo.githubusercontent.com/41248416f39a4bbbe158019d5adf5daab7b1836a5bfc21b30552837da5d4641b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f65776572746f6e64616e69656c2f7069637061792d652d636f6d6d657263652d7068702d73646b)](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE)[![Generic badge](https://camo.githubusercontent.com/df3745ea672d41ec69592038d0fbbb187e111940415bfabc88e0de5fd1bb98e5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f65776572746f6e64616e69656c2f7069637061792d652d636f6d6d657263652d7068702d73646b3f636f6c6f723d626c7565)](https://packagist.org/packages/ewertondaniel/picpay-e-commerce-php-sdk)[![Twitter](https://camo.githubusercontent.com/65786765fa722863eefe78fb4345408b1b430428a7a6333459d16d8c079d24cc/68747470733a2f2f696d672e736869656c64732e696f2f747769747465722f666f6c6c6f772f64737265776572746f6e3f7374796c653d736f6369616c)](https://twitter.com/dsrewerton) πŸ’š PicPay E-Commerce API Integration πŸ‡§πŸ‡· ====================================== [](#-picpay-e-commerce-api-integration-) *This library provides developers with a simple set of bindings to help you integrate [PicPay E-Commerce API](https://studio.picpay.com/produtos/e-commerce) to a website and start receiving payments.* πŸ›  Requirements -------------- [](#-requirements) `php >= 8.1` `guzzlehttp/guzzle >= 7.0.1` `echosistema/simple-http-request" >= 1.0.1` πŸ“’ **Coming soon package to `PHP versions < 8.1`.** πŸ’» Installation -------------- [](#-installation) First time using PicPay? Create your PicPay account in [PicPay Studio](https://studio.picpay.com/download), if you don’t have one already. Download [Composer](https://getcomposer.org/) if not already installed On your project directory run on the command line `"composer require ewertondaniel/picpay-e-commerce-php-sdk"`for `PHP 8.1`; That's it! **PicPay E-Commerce** has been successfully installed! πŸ§‘β€πŸ’» Examples ------------ [](#‍-examples) ### πŸ‘€ Create a Customer/Buyer to Payment Order [](#-create-a-customerbuyer-to-payment-order) ``` use EwertonDaniel\PicPay\Customer; /** * Brazilian CPF and Phone Number can be only numbers or with default mask; * The email and phone number fields are optional; */ $customer = new Customer(); $customer->setFirstName('Anakin') // REQUIRED; ->setLastName('Skywalker') // REQUIRED; ->setEmail('anakin@jediorder.com')) // Optional; ->setPhoneNumber('11987654321')) // Optional; ->setDocument('963.237.510-62'); // REQUIRED, Has a CPF validation rule; ``` ### πŸ’² Create a Payment Order [](#-create-a-payment-order) ``` use EwertonDaniel\PicPay\PicPay; $payment = new PicPay('x_picpay_token'); $payment->setCustomer([ 'first_name' => 'Din', 'last_name' => 'Djarin', 'document' => '963.237.510-62' ]) // REQUIRED, Array or Customer class; ->setReferenceId('MY-ID-0001') //string, call REQUIRED, If you want an auto reference id, please call empty ex.: setReferenceId(); ->setCallbackUrl('https://my-website.com/notification') // REQUIRED, Where PicPay will return with POST notification; ->setValue(100.00) //float, REQUIRED; ->pay(); ``` ### πŸ’² Create a Full Payment Order [](#-create-a-full-payment-order) ``` use EwertonDaniel\PicPay\PicPay; $payment = new PicPay('x_picpay_token'); $payment->setCustomer([ 'first_name' => 'Din', 'last_name' => 'Djarin', 'document' => '963.237.510-62', // It can just be numbers ex.: '96323751062' 'email'=>'din@mandalorian.com', // Optional 'phone_number'=>'11987654321' // Optional, It can just be masked ex.: '(11) 98765-4321, (11) 8765-4321 etc...' ]) // REQUIRED, Array or Customer class; ->setDebug(false) // Optional, (default:false) If you want to debug the request (default false); ->setReferenceId('MY-ID-0002') //string, call REQUIRED, If no value is entered, Reference ID will be created automatically, ex.: setReferenceId(); ->setCallbackUrl('https://my-website.com/notification') // REQUIRED, Where PicPay will return with POST notification; ->setReturnUrl('https://my-website.com/order/MY-ID-0002') // Optional, (default:null) where customer will be redirected from PicPay Payment Page; ->setExpirationDate('2020-09-20') // Optional, (default:null) Format Y-m-d (yyyy-mm-dd); ->setSoftDescriptor('Skywalker light-saber') // Optional, (default:null) The soft descriptor is the dynamic text used to construct the statement descriptor that appears on a payer's card statement; ->setPurchaseMode('online') // Optional, (default: online, available options [online, in-store]); ->setChannel('channel') // Optional, (default:null) If you have another store, take a look in official documentation; ->setAutoCapture(true) // Optional, (default:true) Key that will define that this charge will be of the late capture type; ->setValue(100.00) //float, REQUIRED ->pay() ``` ### β„Ή Get a specific Order Status [](#β„Ή-get-a-specific-order-status) ``` use EwertonDaniel\PicPay\Order; $order = new Order('x_picpay_token','reference_id'); $response = $order->status(); $status = $response['status']; ``` #### Possibles status response when request Order Status: [](#possibles-status-response-when-request-order-status) βœ” created: order created; βœ” expired: payment limit date has expired or order cancelled; βœ” analysis: paid and in the process of anti-fraud analysis; βœ” completed: paid and amount available in your PicPay account; βœ” refunded: paid and refunded; βœ” chargeback: paid with chargeback;### ❌ Cancel a specific Order [](#-cancel-a-specific-order) ``` use EwertonDaniel\PicPay\Order; $order = new Order('x_picpay_token','reference_id'); $response = $order->cancel(); $status = $response['status']; ``` #### Possibles cancellation status response: [](#possibles-cancellation-status-response) βœ” cancelled: order cancelled; βœ” undefined: unknown status;πŸ“– Documentation --------------- [](#-documentation) ### πŸ”— Visit the PicPay Studio for further information regarding: [](#-visit-the-picpay-studio-for-further-information-regarding) [PicPay E-Commerce Official Documentation](https://studio.picpay.com/produtos/e-commerce) ### Health Score 26 β€” LowBetter than 43% of packages Maintenance20 Infrequent updates β€” may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity56 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 ~0 days Total 2 Last Release 1252d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/735b1ba4cf3c6a19b0e75524cd090d21f13a8936799387c579933d2b99789f26?d=identicon)[ewertondaniel](/maintainers/ewertondaniel) --- Top Contributors [![EwertonDaniel](https://avatars.githubusercontent.com/u/42904786?v=4)](https://github.com/EwertonDaniel "EwertonDaniel (27 commits)") --- Tags e-commercewalletPicPay ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/ewertondaniel-picpay-e-commerce-php-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/ewertondaniel-picpay-e-commerce-php-sdk/health.svg)](https://phpackages.com/packages/ewertondaniel-picpay-e-commerce-php-sdk) ``` ### Alternatives [sylius/invoicing-plugin Invoicing plugin for Sylius. 901.0M2](/packages/sylius-invoicing-plugin)[amsgames/laravel-shop Package set to provide shop or e-commerce functionality (such as CART, ORDERS, TRANSACTIONS and ITEMS) to Laravel for customizable builds. 4845.9k](/packages/amsgames-laravel-shop)[aimeos/ai-payments Payment extension for Aimeos e-commerce solutions 2160.7k](/packages/aimeos-ai-payments)[lunarphp/stripe Stripe payment driver for Lunar. 2055.8k4](/packages/lunarphp-stripe)[bavix/laravel-wallet-swap Addition to the package laravel-wallet. 2427.2k](/packages/bavix-laravel-wallet-swap)[commerceredsys/sermepa Payment gateway library for spanish banks that use Sermepa/RedsΓ½s systems. 1062.0k](/packages/commerceredsys-sermepa) PHPackages Β© 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)