290 lines
20 KiB
Markdown
290 lines
20 KiB
Markdown
## KORE PHP LIB ##
|
|
|
|
|
|
## Índice
|
|
|
|
- [Classe: `PIX`](#classe-pix)
|
|
- [Função: `pixCobrancaDinamicoImediataSemValor`](#função-pixcobrancadinamicoimediatasemvalor)
|
|
- [Função: `pixCobrancaDinamicoImediataComValor`](#função-pixcobrancadinamicoimediatacomvalor)
|
|
- [Função: `pixCobrancaDinamicoImediataSaqueComValor`](#função-pixcobrancadinamicoimediatasaquecomvalor)
|
|
- [Função: `pixCobrancaDinamicoImediataSaqueSemValor`](#função-pixcobrancadinamicoimediatasaquesemvalor)
|
|
- [Função: `pixCobrancaDinamicoImediataTrocoComValor`](#função-pixcobrancadinamicoimediatatrococomvalor)
|
|
- [Função: `pixCobrancaDinamicoImediataTrocoSemValor`](#função-pixcobrancadinamicoimediatatrocosemvalor)
|
|
- [Função: `pixCobrancaEstatico`](#função-pixcobrancaestatico)
|
|
|
|
### Classe: `PIX`
|
|
|
|
**Descrição:**
|
|
Classe padrão para consumo das funções de PIX do Kore, utilizado para gerar cobranças, transferir valores e etc.
|
|
|
|
**Como Usar**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone, $environment);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Descrição |
|
|
|----------------|--------|-------------|--------------------------------------------------------------------------|
|
|
| `$priv` | string | Sim | Chave privada para assinatura da requisição |
|
|
| `$drone` | string | Sim | ID do drone gerado e fornecido pela Kontrl |
|
|
| `$environment` | string | Não | Ambiente a ser utilizado - Aceito: **PROD** ou **DEV** - Padrão: **DEV** |
|
|
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataSemValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata sem valor predefinido, ou com valor sugerido. O usuário pagador poderá alterar o valor na hora do pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediataSemValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|--------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Não | Valor sugerido | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataComValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata com valor predefinido, o usuário pagador não poderá alterar o valor ao efetuar o pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediataComValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|--------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Sim | Valor sugerido | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataSaqueComValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata para SAQUE com valor predefinido, o usuário pagador não poderá alterar o valor ao efetuar o pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediatoSaqueComValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Sim | Valor do saque | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
| `ispb` | string | Sim | ISPB da instituição do prestador de serviço do saque | `"33233"` |
|
|
| `modalidadeAgente` | string | Sim | Indica a modalidade do agente a qual se dará a facilitação do serviço. DEVE SER: "agtot", "agtec" ou "agpss" | `"agtot"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataSaqueSemValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata para SAQUE sem valor predefinido, o usuário pagador poderá alterar o valor ao efetuar o pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediatoSaqueSemValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|--------------------------------------------------------------------------------------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Não | Valor sugerido | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
| `ispb` | string | Sim | ISPB da instituição do prestador de serviço do saque | `"33233"` |
|
|
| `modalidadeAgente` | string | Sim | Indica a modalidade do agente a qual se dará a facilitação do serviço. DEVE SER: "agtot", "agtec" ou "agpss" | `"agtot"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataTrocoComValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata para TROCO com valor predefinido, o usuário pagador não poderá alterar o valor ao efetuar o pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediatoTrocoComValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|-----------------------------------------------------------------------------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Sim | Valor do troco | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
| `ispb` | string | Sim | ISPB da instituição do prestador de serviço do troco | `"33233"` |
|
|
| `modalidadeAgente` | string | Sim | Indica a modalidade do agente a qual se dará a facilitação do serviço. DEVE SER: "agtot" ou "agtec" | `"agtot"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
### Função: `pixCobrancaDinamicoImediataTrocoSemValor`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX dinâmica e imediata para TROCO sem valor predefinido, o usuário pagador poderá alterar o valor ao efetuar o pagamento.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaDinamicoImediatoTrocoSemValor($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|-----------------------------------------------------------------------------------------------------|-------------------------|
|
|
| `expiracao` | int | Sim | Tempo de expiração em segundos | `3600` |
|
|
| `devedor.documento` | string | Não | Documento do pagador | `"09432312054"` |
|
|
| `devedor.nome` | string | Não, somente se o documento for informado | Nome do pagador | `"Fulano da Silva"` |
|
|
| `valor` | int | Não | Valor sugerido | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
| `ispb` | string | Sim | ISPB da instituição do prestador de serviço do troco | `"33233"` |
|
|
| `modalidadeAgente` | string | Sim | Indica a modalidade do agente a qual se dará a facilitação do serviço. DEVE SER: "agtot" ou "agtec" | `"agtot"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|
|
|
|
|
|
### Função: `pixCobrancaEstatico`
|
|
|
|
**Descrição:**
|
|
Gera uma cobrança PIX estática com ou sem valor predefinido.
|
|
|
|
**Como usar:**
|
|
```php
|
|
$class = new \Kontrl\PhpKore\Pix($priv, $drone);
|
|
$class->pixCobrancaEstatico($dados);
|
|
```
|
|
|
|
**Parâmetros:**
|
|
|
|
| Nome | Tipo | Obrigatório | Padrão | Descrição |
|
|
|----------|-------|-------------|--------|-----------------------------------------------------------------|
|
|
| `$dados` | array | Sim | — | Um array com os dados a serem enviados para geração da cobrança |
|
|
|
|
**Dados:**
|
|
|
|
| Chave | Tipo | Obrigatório | Descrição | Exemplo |
|
|
|----------------------|--------|-------------------------------------------|--------------------------------|-------------------------|
|
|
| `valor` | int | Não | Valor sugerido | `10000` (R$100,00) |
|
|
| `chave` | string | Sim | Chave Pix de destino | `"12345678911"` |
|
|
| `txid` | string | Sim | Identificador da transação | `"098765432111"` |
|
|
| `solicitacaoPagador` | string | Não | Mensagem opcional ao pagador | `"Mensagem ao usuário"` |
|
|
|
|
**Retorno:**
|
|
Tipo: `array`
|
|
|
|
**Notas adicionais:**
|
|
- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido.
|