README

此包提供了与Sicoob系统API PIX的集成，具体请参阅巴西中央银行文档。

注意

此包提供的端点遵循中央银行的标准：[链接文档](https://bacen.github.io/pix-api/)。然而，支付服务提供商（PSP）可能不会实现所有这些端点。

安装

composer require elemke/sicoob-pix

初始配置

在您的.env文件中配置包变量（如果该文件不存在，则在项目根目录中创建它）

SICOOBPIX_CLIENT_ID='xxxxx'
SICOOBPIX_CAMINHO_CERT_PUBLICO='./path/file.pem'
SICOOBPIX_SENHA_CERT_PUBLICO='xxx'
SICOOBPIX_CAMINHO_CERT_PRIVADO='./path/file.key'
SICOOBPIX_SENHA_CERT_PRIVADO='xxx'

如果您对如何获取这些数据有疑问，请通过以下链接访问Sicoob Developers网站：[开发者网站](https://developers.sicoob.com.br)

使用示例

创建即时收费

$scope = ['cob.read', 'cob.write']; //Veja a lista completa na documentação do Banco Central
$psp = new Psp($scope);

$cobranca = [
    'calendario' => [
        'expiracao' => 3600
    ],
    'devedor' => [
        'cpf' => '12345678911',
        'nome' => 'Fulano'
    ],
    'valor' => [
        'original' => '1.00'
    ],
    'chave' => 'teste@teste.com',
    'solicitacaoPagador' => 'mensagem pagador'
];

$cob = new Cob($psp);
$cob->criar($cobranca); //Como segundo parâmetro é possível informar o txId, caso contrário será gerado automaticamente pelo PSP

查询即时收费

$cob->consultar('xxxx'); // Para consultar cobrança pelo txId

$parametros = ['inicio' => '2021-09-01T01:00:00-03:00', 'fim' => '2021-09-10T01:00:00-03:00']; // Consulte o site do Banco Central para outras opções de filtros
$cob->consultar(null, $parametros);

修改/审查即时收费

$cobranca = [
    'calendario' => [
        'expiracao' => 3600
    ],
    'devedor' => [
        'cpf' => '12345678911',
        'nome' => 'Fulano'
    ],
    'valor' => [
        'original' => '2.00'
    ],
    'chave' => 'teste@teste.com',
    'solicitacaoPagador' => 'mensagem pagador'
];

$cob->alterar($cobranca, 'xxxx');

创建webhook

$scope = ['webhook.read', 'webhook.write']; //Veja a lista completa na documentação do Banco Central
$psp = new Psp($scope);
$webhook = new \Elemke\SicoobPix\Webhook($psp);
$webhook->criar('teste@teste.com', 'https://www.teste.com');

查询webhook

$webhook = new \Elemke\SicoobPix\Webhook($psp);
$webhook->consultar('teste@teste.com');

删除webhook

$webhook = new \Elemke\SicoobPix\Webhook($psp);
$webhook->deletar('teste@teste.com');

许可证

MIT