PHPackages descubraomundo/omnipay-ebanx - 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. descubraomundo/omnipay-ebanx ActiveLibrary[Payment Processing](/categories/payments) descubraomundo/omnipay-ebanx ============================ Ebanx driver for the Omnipay payment processing library v1.1(6y ago)16161MITPHP Since Aug 25Pushed 6y ago1 watchersCompare [ Source](https://github.com/descubraomundo/omnipay-ebanx)[ Packagist](https://packagist.org/packages/descubraomundo/omnipay-ebanx)[ Docs](https://github.com/descubraomundo/omnipay-ebanx)[ RSS](/packages/descubraomundo-omnipay-ebanx/feed)WikiDiscussions master Synced yesterday READMEChangelogDependencies (4)Versions (4)Used By (0) Omnipay: Ebanx ============== [](#omnipay-ebanx) **Ebanx gateway for the Omnipay PHP payment processing library** [![Latest Version on Packagist](https://camo.githubusercontent.com/6ae1c19e51d6ec6719f77a28488f377eab3fb8f75b65e85832c6a8762753812f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f64657363756272616f6d756e646f2f6f6d6e697061792d6562616e782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/descubraomundo/omnipay-ebanx)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/06b0308fd9ec27cdc8f1c735f4daf54cefe271736ecf9f9edcfc15f05fb429ec/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f64657363756272616f6d756e646f2f6f6d6e697061792d6562616e782f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/descubraomundo/omnipay-ebanx)[![Coverage Status](https://camo.githubusercontent.com/a04b7837ee2632cedf80e934699bcf95809649135d38b2cdbffb3102dd814622/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f636f7665726167652f672f64657363756272616f6d756e646f2f6f6d6e697061792d6562616e782e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/descubraomundo/omnipay-ebanx/code-structure)[![Quality Score](https://camo.githubusercontent.com/bd1ae495e23ac1b69949e5a3198a0a86c6d4a6aafb7b6bdd90df6737e9246617/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f64657363756272616f6d756e646f2f6f6d6e697061792d6562616e782e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/descubraomundo/omnipay-ebanx)[![Total Downloads](https://camo.githubusercontent.com/2c3a3dfdc0ce9861ba90e6bdc21fa78febd39ac1c4b8358b646dc4f3e76b4322/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f64657363756272616f6d756e646f2f6f6d6e697061792d6562616e782e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/descubraomundo/omnipay-ebanx) [Omnipay](https://github.com/thephpleague/omnipay) is a framework agnostic, multi-gateway payment processing library for PHP 5.3+. This package implements Pagar.Me support for Omnipay. This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors. Install ------- [](#install) Instal the gateway using require. Require the `league/omnipay` base package and this gateway. ``` $ composer require league/omnipay descubraomundo/omnipay-ebanx ``` Usage ----- [](#usage) The following gateways are provided by this package: - Ebanx For general usage instructions, please see the main [Omnipay](https://github.com/thephpleague/omnipay) repository. ### Example with Credit Card [](#example-with-credit-card) ``` // Create a gateway for the Ebanx Gateway // (routes to GatewayFactory::create) $gateway = Omnipay::create('Ebanx'); // Initialise the gateway $gateway->initialize(array( 'integration_key' => 'MyApiKey', )); // Create a credit card object // This card can be used for testing. $card = new CreditCard(array( 'firstName' => 'Example', 'lastName' => 'Customer', //'name' => 'Example Customer', 'birthday' => '1988-02-28', 'gender' => 'M', 'number' => '4242424242424242', 'expiryMonth' => '01', 'expiryYear' => '2020', 'cvv' => '123', 'email' => 'customer@example.com', 'address1' => 'Street name, Street number, Complementary', 'address2' => 'Neighborhood', 'postcode' => '05443100', 'phone' => '19 3242 8855', )); // Do an authorize transaction on the gateway $transaction = $gateway->authorize(array( 'amount' => '10.00', 'paymentMethod' => 'creditcard', 'installments' => 5, 'documentNumber' => '246.375.149-23', // CPF or CNPJ 'notifyUrl' => 'http://application.com/api/', 'card' => $card, // 'cardReference' => 'card_k5sT...', )); $response = $transaction->send(); if ($response->isSuccessful()) { echo "Authorize transaction was successful!\n"; $sale_id = $response->getTransactionReference(); echo "Transaction reference = " . $sale_id . "\n"; } ``` ### Example with Boleto [](#example-with-boleto) ``` // Create a gateway for the Ebanx Gateway // (routes to GatewayFactory::create) // Create array with customer data $customer = array( 'firstName' => 'Example', 'lastName' => 'Customer',, 'email' => 'customer@example.com', 'address1' => 'Street name, Street number, Complementary', 'address2' => 'Neighborhood', 'postcode' => '05443100', 'phone' => '19 3242 8855', )); // Create a credit card object // The card object is required by default to get all the customer information, even if you want to use boleto payment method. $card = new CreditCard(array( 'firstName' => 'Example', 'lastName' => 'Customer', //'name' => 'Example Customer', 'birthday' => '1988-02-28', 'gender' => 'M', 'number' => '4242424242424242', 'expiryMonth' => '01', 'expiryYear' => '2020', 'cvv' => '123', 'email' => 'customer@example.com', 'address1' => 'Street name, Street number, Complementary', 'address2' => 'Neighborhood', 'city' => 'City', 'state' => 'sp', 'country' => 'BR', 'postcode' => '05443100', 'phone' => '19 3242 8855', )); // Do an authorize transaction on the gateway $transaction = $gateway->authorize(array( 'amount' => '10.00', 'paymentMethod' => 'boleto', 'documentNumber' => '246.375.149-23', // CPF or CNPJ 'notifyUrl' => 'http://application.com/api/', 'card' => $card, )); $response = $transaction->send(); if ($response->isSuccessful()) { echo "Authorize Boleto transaction was successful!\n"; $sale_id = $response->getTransactionReference(); $boleto = $response->getBoleto(); echo "Boleto Url = " . $boleto['boleto_url']; echo "Boleto Barcode = " . $boleto['boleto_barcode']; echo "Boleto Expiration Date = " . $boleto['boleto_expiration_date']; echo "Transaction reference = " . $sale_id . "\n"; } ``` Test Mode --------- [](#test-mode) Ebanx accounts use two different endpoints for the sandbox-mode and live-mode using the same API key. In case you want to use sandbox-mode just pass the testMode parameter when seting up the gateway: ``` // Create a gateway for the Ebanx Gateway // (routes to GatewayFactory::create) $gateway = Omnipay::create('Ebanx'); // Initialise the gateway $gateway->initialize(array( 'testMode' => true, 'integration_key' => 'MyApiKey', )); ``` Data created with sandbox-mode credentials will never hit the credit card networks and will never cost anyone money. Support ------- [](#support) If you are having general issues with Omnipay, we suggest posting on [Stack Overflow](http://stackoverflow.com/). Be sure to add the [omnipay tag](http://stackoverflow.com/questions/tagged/omnipay) so it can be easily found. If you want to keep up to date with release announcements, discuss ideas for the project, or ask more detailed questions, there is also a [mailing list](https://groups.google.com/forum/#!forum/omnipay) which you can subscribe to. If you believe you have found a bug, please report it using the [GitHub issue tracker](https://github.com/descubraomundo/omnipay-ebanx/issues), or better yet, fork the library and submit a pull request. Change log ---------- [](#change-log) Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently. Testing ------- [](#testing) ``` $ composer test ``` Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Security -------- [](#security) If you discover any security related issues, please email instead of using the issue tracker. Credits ------- [](#credits) - [descubraomundo](https://github.com/descubraomundo) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community8 Small or concentrated contributor base Maturity60 Established project with proven stability 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 ~1 days Total 2 Last Release 2451d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/3d0a2a9c76a119d1fc79a79ba5a3eaabf1292ae867e0fd1043bd3945309c2c09?d=identicon)[descubraomundo](/maintainers/descubraomundo) --- Top Contributors [![gpassarelli](https://avatars.githubusercontent.com/u/1556169?v=4)](https://github.com/gpassarelli "gpassarelli (59 commits)") --- Tags ebanxebanx-gatewaygatewayomnipaypaymentsomnipayebanx ### Code Quality Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/descubraomundo-omnipay-ebanx/health.svg) ``` [![Health](https://phpackages.com/badges/descubraomundo-omnipay-ebanx/health.svg)](https://phpackages.com/packages/descubraomundo-omnipay-ebanx) ``` ### Alternatives [league/omnipay Omnipay payment processing library 6.1k9.7M166](/packages/league-omnipay)[silverstripe/silverstripe-omnipay SilverStripe Omnipay Payment Module 38106.0k15](/packages/silverstripe-silverstripe-omnipay) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)