diff --git a/README.md b/README.md index 488e412..d1314f6 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ - [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` @@ -253,3 +254,36 @@ 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.