PixTroco e PixSaque documentation
This commit is contained in:
parent
5da8edc426
commit
847da21c02
1 changed files with 191 additions and 2 deletions
193
README.md
193
README.md
|
|
@ -59,7 +59,7 @@ Tipo: `array`
|
||||||
### Função: `pixCobrancaDinamicoImediataComValor`
|
### Função: `pixCobrancaDinamicoImediataComValor`
|
||||||
|
|
||||||
**Descrição:**
|
**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:**
|
**Como usar:**
|
||||||
```php
|
```php
|
||||||
|
|
@ -89,4 +89,193 @@ $class->pixCobrancaDinamicoImediataComValor($dados);
|
||||||
Tipo: `array`
|
Tipo: `array`
|
||||||
|
|
||||||
**Notas adicionais:**
|
**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.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue