93 lines
4.7 KiB
Markdown
93 lines
4.7 KiB
Markdown
|
## KORE PHP LIB ##
|
||
|
|
|
||
|
|
### 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);
|
||
|
|
```
|
||
|
|
|
||
|
|
**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 |
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
### 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 a cobrança.
|
||
|
|
|
||
|
|
**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.
|