From 847da21c0253b3863611ec8cd490163f49c21048 Mon Sep 17 00:00:00 2001 From: Eduardo Bacarin Date: Mon, 7 Jul 2025 14:24:13 -0300 Subject: [PATCH] PixTroco e PixSaque documentation --- README.md | 193 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 191 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 58b3efa..fe29412 100644 --- a/README.md +++ b/README.md @@ -59,7 +59,7 @@ Tipo: `array` ### 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. +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 @@ -89,4 +89,193 @@ $class->pixCobrancaDinamicoImediataComValor($dados); Tipo: `array` **Notas adicionais:** -- Lança `Exception` se algum dado obrigatório do array estiver vazio ou inválido. +- 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.