PHPackages                             wfpay/pjbank - 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. wfpay/pjbank

ActiveLibrary[API Development](/categories/api)

wfpay/pjbank
============

Biblioteca para comunicaçao com a API de Recebimentos PJBank

0121PHP

Since Dec 17Pushed 1y ago1 watchersCompare

[ Source](https://github.com/DevNF/pjbank)[ Packagist](https://packagist.org/packages/wfpay/pjbank)[ RSS](/packages/wfpay-pjbank/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Integração PJBank
=================

[](#integração-pjbank)

A integração com cartão de crédito deve ser feita sem intermediários ou seja quando o cliente final pagar uma cobrança, o valor deve ser creditado diretamente na conta do nosso cliente após a liberação do valor.

Então precisamos credenciar os clientes que utilizarão o wfpay com os dados deles vinculandos nossa agência ao cadastro deles.

Documentação da API da PJBank: [Acessar da documentação](https://docs.pjbank.com.br/)

Como utilizar
=============

[](#como-utilizar)

O Fluxo de cobrança é o seguinte:

1. Realizamos a tokenização do número do cartão de crédito do cliente no pela biblioteca disponibilizada pela PJBank.
2. Com a tokenização do cartão de crédito, realizamos a inserção dos demais dados pela rota de Validação do token do cartão de crédito.
3. Com os dados validados, realizamos a criação da cobrança pela rota de criação de cobrança com o token do cartão de crédito.
4. Com a cobrança criada, realizamos a consulta da cobrança pela rota de consulta de cobrança.

Importante ressaltar que a biblioteca do PJBank é utilizada para a tokenização do cartão de crédito e a criação da cobrança, a validação do token do cartão de crédito e a consulta da cobrança são realizadas diretamente pela API do PJBank, não salvar nenhuma informação do cartão de crédito do cliente a não ser o token disponibilizado pela PJBank somente empresas [PCI Compliance](https://pt.pcisecuritystandards.org/) podem salvar informações de cartão de crédito.

Para utilizar a biblioteca do PJBank, primeiramente é necessário instalar a mesma em seu projeto. Para isso, execute o seguinte comando:

```
composer require pjbank/pjbank-php-sdk
```

Depois de instalada precisamos instanciar a classe `ApiPjbank` passando os parâmetros necessários para a autenticação.

```
$pjbank = new ApiPjbank(
    'credencial',
    'chave',
    false, // Utilizar ambiente de produção
    false, // Utilizar debug das requisições efetuadas
);
```

Métodos disponíveis
-------------------

[](#métodos-disponíveis)

Aqui estão listados os métodos disponíveis na biblioteca do PJBank.

### Credenciamento

[](#credenciamento)

#### Cadastro de clientes

[](#cadastro-de-clientes)

Você consegue cadastrar um cliente no PJBank utilizando o método `cadastrarCliente` passando um array com os dados do cliente que podem ser encontrados na [documentação](https://docs.pjbank.com.br/#45e7e7a5-4d02-45ac-ab58-2d4193761806).

```
$pjbank->Credenciamento()->cadastrarCliente($dadosDoCliente);
```

#### Consulta de clientes

[](#consulta-de-clientes)

Também é possível consultar um cliente utilizando o método `consultarCliente` passando a `credencial` e `chave` do cliente na instância do PJBank.

```
$pjbank->Credenciamento()->consultarCliente();
```

### Cartão de Crédito

[](#cartão-de-crédito)

#### Criação de cobranças

[](#criação-de-cobranças)

Para criar uma cobrança no cartão de crédito, você pode utilizar o método `criarCobrancaCartaoViaToken` passando um array com os dados da cobrança nessa rota é utilizado a criação de cobrança com a tokenização do número do cartão de crédito sendo efetuado no front end para remover a necessidade de ser PCI Compliance, esse metodo também é fornecido pelo PJBank e disponível na [documentação](https://docs.pjbank.com.br/#b2367781-5156-4e96-a500-fdb74d3b6998), sobre os dados adicionais que devem ser enviados para a criação da cobrança consulte a [documentação](https://docs.pjbank.com.br/#ac40e9ae-91b6-4fee-936c-75ceb1f81d73).

```
$pjbank->CartaoCredito()->criarCobrancaCartaoViaToken($dadosDaCobranca);
```

#### Consulta de cobranças

[](#consulta-de-cobranças)

Para consultar uma cobrança no cartão de crédito, você pode utilizar o método `consultarTransacaoViaTid` passando o `tid` da cobrança.

```
$pjbank->CartaoCredito()->consultarTransacaoViaTid('tid');
```

Também é possível consultar utilizando o número do pedido caso tenha sido utilizado na criação da cobrança via `consultarTransacaoViaNumeroPedido`.

```
$pjbank->CartaoCredito()->consultarTransacaoViaNumeroPedido('pedido_numero');
```

#### Cancelamento de cobranças

[](#cancelamento-de-cobranças)

Para cancelar uma cobrança no cartão de crédito, você pode utilizar o método `cancelarCobrancaCartao` passando o `tid` da cobrança.

```
$pjbank->CartaoCredito()->cancelarCobrancaCartao('tid');
```

###  Health Score

16

—

LowBetter than 4% of packages

Maintenance29

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity16

Early-stage or recently created project

 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.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/2781050?v=4)[NFSERVICE](/maintainers/NFService)[@nfservice](https://github.com/nfservice)

---

Top Contributors

[![henriquernandes](https://avatars.githubusercontent.com/u/61748405?v=4)](https://github.com/henriquernandes "henriquernandes (2 commits)")

### Embed Badge

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

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

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

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