PHPackages                             ebanx/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. [API Development](/categories/api)
4. /
5. ebanx/ebanx

ActiveLibrary[API Development](/categories/api)

ebanx/ebanx
===========

EBANX PHP library

1.12.0(7y ago)24669.0k↓50.2%9[2 issues](https://github.com/ebanx-integration/ebanx-php/issues)BSDPHPPHP >=5.3.0

Since Dec 24Pushed 2w ago14 watchersCompare

[ Source](https://github.com/ebanx-integration/ebanx-php)[ Packagist](https://packagist.org/packages/ebanx/ebanx)[ Docs](https://ebanx.com)[ RSS](/packages/ebanx-ebanx/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (3)Dependencies (2)Versions (16)Used By (0)

> ⚠️ **DEPRECATED** — This repository is no longer maintained. Please refer to the [official EBANX documentation](https://docs.ebanx.com/) for up-to-date integration options.

EBANX PHP Library [![Build Status](https://camo.githubusercontent.com/fe56c374e5ddb90b1d14c2eebecdbbf55c0ece1b626b173dc4e98f4a6b5f7df7/68747470733a2f2f7472617669732d63692e6f72672f6562616e782d696e746567726174696f6e2f6562616e782d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/ebanx-integration/ebanx-php) [![Code Climate](https://camo.githubusercontent.com/8e40f3785cc0eef2ba28026e90be463a5fbe82f12696706bb0e05362de80ca2b/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6562616e782d696e746567726174696f6e2f6562616e782d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/ebanx-integration/ebanx-php) [![Test Coverage](https://camo.githubusercontent.com/d99500169bcd1138b7ac197ba8a45c947b2e09b99bebcb47ff902377796b9187/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6562616e782d696e746567726174696f6e2f6562616e782d7068702f6261646765732f636f7665726167652e737667)](https://codeclimate.com/github/ebanx-integration/ebanx-php/coverage)
==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#ebanx-php-library---)

EBANX is the market leader in e-commerce payment solutions for International Merchants selling online to Brazil. This library enables you to integrate EBANX with any PHP application.

Requirements
------------

[](#requirements)

- PHP >= 5.3
- cURL

Installation
------------

[](#installation)

### Composer

[](#composer)

The EBANX library is available on Packagist (), therefore you can install it by simply updating your composer.json file:

```
{
  "require" : {
    "ebanx/ebanx": "dev-master"
  }
}
```

After that run *composer install* and wait for it to finish. Include the Composer generated autoloader from 'vendor/autoload.php' and you're ready to use the library.

### Git Repository

[](#git-repository)

Clone the git repository anywhere you want and include the EBANX library autoloader from 'src/autoload.php'.

Usage
-----

[](#usage)

### Setup

[](#setup)

To use the EBANX PHP library you need to setup your integration key.

```
\Ebanx\Config::setIntegrationKey('your-integration-key');
```

If you need to change other settings, you can use the following function call:

```
\Ebanx\Config::set([
    'integrationKey' => 'your-integration-key'
  , 'testMode'       => true
]);
```

You can change the following settings:

- integrationKey: your integration key. It will be different in test and production modes.
- testMode: enable or disable the test mode. The default value is *false*.
- directMode: enable or disable the direct checkout mode. The default value is *false*.

To create a new API request, just call one of the following methods on the \\Ebanx\\Ebanx class and supply it with the request parameters:

- \\Ebanx\\Ebanx::doCancel
- \\Ebanx\\Ebanx::doCapture
- \\Ebanx\\Ebanx::doExchange
- \\Ebanx\\Ebanx::doPrintHtml
- \\Ebanx\\Ebanx::doQuery
- \\Ebanx\\Ebanx::doRefund
- \\Ebanx\\Ebanx::doRefundOrCancel
- \\Ebanx\\Ebanx::doRequest
- \\Ebanx\\Ebanx::doToken
- \\Ebanx\\Ebanx::doZipcode

doRequest command example:

```
require_once __DIR__ . 'vendor/autoload.php';

\Ebanx\Config::setIntegrationKey('6e556ff76e55...56ff7');

$request = \Ebanx\Ebanx::doRequest([
    'currency_code'     => 'USD'
  , 'amount'            => 119.90
  , 'name'              => 'Jose da Silva'
  , 'email'             => 'jose@example.org'
  , 'payment_type_code' => 'boleto'
  , 'merchant_payment_code' => '10101101'
]);
```

Changelog
---------

[](#changelog)

- **1.11.0**: changed EBANX API Endpoint
- **1.10.0**: added Curl
- **1.9.0**: added getBankList operation
- **1.8.0**: added documentBalance operation
- **1.7.0**: added hardcoded autoloader, removed Guzzle to avoid dependencies
- **1.6.1**: removed manual autoloader
- **1.6.0**: added fallback HTTP client for environments without curl
- **1.5.1**: removed *modify* method, removed *request* constraints
- **1.5.0**: changed HTTP client to Guzzle
- **1.4.1**: updated production URL.
- **1.4.0**: added custom user agent, made library PSR compliant.
- **1.3.0**: added Zipcode operation, improved HTTP Client error handling.
- **1.2.1**: updated autoloader and sandbox URL.
- **1.2.0**: added Token operation.
- **1.1.0**: added business person to Direct mode.
- **1.0.0**: first release.

###  Health Score

53

—

FairBetter than 96% of packages

Maintenance62

Regular maintenance activity

Popularity48

Moderate usage in the ecosystem

Community21

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 76.5% 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 ~145 days

Recently: every ~306 days

Total

14

Last Release

2685d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/5168667?v=4)[EBANX](/maintainers/ebanx)[@ebanx](https://github.com/ebanx)

![](https://www.gravatar.com/avatar/d44ddf629db094b6fa4debe2e7a5b8c659fc76bb99b486aec5e7b5cebb1c5768?d=identicon)[ebanx-integration](/maintainers/ebanx-integration)

---

Top Contributors

[![guhemama](https://avatars.githubusercontent.com/u/1319184?v=4)](https://github.com/guhemama "guhemama (39 commits)")[![lcscarvalho](https://avatars.githubusercontent.com/u/6865545?v=4)](https://github.com/lcscarvalho "lcscarvalho (4 commits)")[![arthuracq](https://avatars.githubusercontent.com/u/12537011?v=4)](https://github.com/arthuracq "arthuracq (3 commits)")[![afstarosta](https://avatars.githubusercontent.com/u/12430119?v=4)](https://github.com/afstarosta "afstarosta (2 commits)")[![licianeandreatta](https://avatars.githubusercontent.com/u/906290?v=4)](https://github.com/licianeandreatta "licianeandreatta (2 commits)")[![williandricken](https://avatars.githubusercontent.com/u/15013952?v=4)](https://github.com/williandricken "williandricken (1 commits)")

---

Tags

apipayment processingebanx

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ebanx-ebanx/health.svg)

```
[![Health](https://phpackages.com/badges/ebanx-ebanx/health.svg)](https://phpackages.com/packages/ebanx-ebanx)
```

###  Alternatives

[pay-now/paynow-php-sdk

PHP client library for accessing Paynow API

19214.3k3](/packages/pay-now-paynow-php-sdk)[everypay/everypay-php

1743.5k](/packages/everypay-everypay-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)