2.7 - Gerar boleto sob Demanda

Índice

1 Índice
- 1.1 Utilização deste método
- 1.2 Parâmetros de entrada
2 Critérios de preenchimento
3 Objetos e atributos de retorno
4 Método de gerarBoleto
- 4.1 Endpoint
- 4.2 Parâmetros de entrada
- 4.3 Exemplo request
- 4.4 Descrição dos objetos e atributos de retorno - Sucesso
  - 4.4.1 Exemplo retorno API - sucesso
  - 4.4.2 Descrição dos objetos e atributos de retorno - falha
  - 4.4.3 Exemplo retorno API - falha

Só são suportadas integrações no padrão REST.

Utilização deste método

Utilize este método APENAS SE sua empresa desejar GERAR UMA ATUALIZAÇÃO DE BOLETOS E REGISTRO ONLINE de carteira com seu banco. Se sua empresa já registra os títulos através de modalidade de carteira registrada, NÃO UTILIZE esse método.

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

Critérios de preenchimento

Abreviação	Nome	Descrição

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

Método de gerarBoleto

Endpoint

Endpoint	Método	Header Content-Type	Descrição

Endpoint

Método

Header Content-Type

Descrição

http://exemplo.com /gerarBoleto

POST

application/json

solicitar ao cliente a geração de um boleto de pagamento para o cliente.

Parâmetros de entrada

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro	Obrigatório	Tipo	Descrição
idTitulo	M	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

url: 
https://www.operadoradesaude.com.br/mobilesaude/gerarBoleto

Body:
{
  "chaveUnica": "101012",
  "integracao": {
    "xpto": "voluptatibus",
    "xyz": "quibusdam",
    "abcdef": 9288701
  },
  "idTitulo": 579,
  "codigoTitulo": "MS00579"
}

Descrição dos objetos e atributos de retorno - Sucesso

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

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
linhaDigitavel	M	String	linha digitavel completa sem pontos ou tracos	texto livre
informacoes	OP	String	informações pertinentes ao boleto	texto livre

Exemplo retorno API - sucesso

{
  "linhaDigitavel": "2147483647",
  "informacoes": "Minima et sit iste dolores. "
}

Descrição dos objetos e atributos de retorno - falha

Objetos e atributos de retorno

Atributo	Critério	Tipo	Descrição	Regra de preenchimento

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

{
  "mensagem": "Não foi possível obter os detalhes deste débito. Por favor, entre em contato com suporte."
}