Índice
| Índice | ||||
|---|---|---|---|---|
|
...
Critérios de preenchimento
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 |
Objetos e atributos de retorno
| Nota |
|---|
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração. Exemplo do atributo “contratos”:
|
Método de resumoCobranca
| Dica |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
exemplo.com/resumoCobranca | POST | application/json | Endpoint para retornar as informações para exibir o resumo de cobrança |
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
idTitulo | OP | Number | Id de banco de dados da título no seu sistema interno. |
codigoTitulo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo codigoTitulo do método listaDebito |
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | OP | Objeto | Nó integração retornado no login do usário |
Exemplo request
| Bloco de código | ||
|---|---|---|
| ||
url:
https://www.operadoradesaude.com.br/mobilesaude/resumoCobranca
Body:
{
"chaveUnica": "101012",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"idTitulo": 579,
"codigoTitulo": "MS00579"
} |
...
Está indicado abaixo a estrutura de retorno do seu método login. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | titulo da tela | texto livre |
tituloTotalizador | M | String | titulo totalizador dos registros de cobranças | texto livre |
valorTotal | M | Float | valor total do débito |
|
dataVencimento | M | String | Data de vencimento da fatura | Formato: Formato: YYYY-MM-DD |
registros | M | Array | Array de objetos do tipo "registro" |
|
Objeto registro
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | titulo da tela | texto livre |
icone | OP | String |
| |
valorTotal | M | Float | Valor total do registro |
|
valores | M | Array | Array de objetos do tipo "cobranca" |
|
Objeto cobranca
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
id | M | String | id da cobranca no seu sistema | texto livre |
descricao | M | String | Descrição da cobrança | texto livre |
valor | M | Float | Valor da cobrança |
|
Exemplo retorno API - sucesso
...
Objetos e atributos de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo retorno API - falha
...