| Índice |
|---|
Informações
...
| Abreviação | Nome | Descrição |
|---|---|---|
| M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
| C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
| OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
| Nota | ||
|---|---|---|
| ||
Os métodos a seguir SÃO OBRIGATÓRIOS:
Os demais métodos são opcionais, porém devem ser considerados para uma boa experiência de uso do app:
|
Método "listaDebitos"
Este método irá retornar a lista de débitos relacionados ao beneficiário. A quantidade de débitos retornados, o período e a regra deste retorno fica a critério da operadora.
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/listaDebitos
| POST | application/json | Endpoint para listar débitos relacionados ao localizador (chaveBeneficiario). |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/detalheDebito
| POST | application/json | Endpoint que retorna o detalhamento de um débito |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo tituloCodigo do método listaDebitos |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do método listaDebitos |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloCodigo do método listaDebitos. |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do método listaBoleto. |
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloCodigo do EndPoint listaDebitos |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do EndPoint listaDebitos. |
...