diff --git a/README.md b/README.md index fe29412..488e412 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ ## 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) + ### Classe: `PIX` **Descrição:** @@ -55,43 +66,6 @@ Tipo: `array` - 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: `pixCobrancaDinamicoImediataComValor` **Descrição:**