2.4 - Comprovante pagamento em PDF

Índice

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

Orientações

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

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”:

  • Contrato

  • contrato

  • Contratos

  • contratos

 

Método de comprovantePdf

Endpoint

Endpoint

Método

Header Content-Type

Descrição

Endpoint

Método

Header Content-Type

Descrição

exemplo.com/comprovantePdf

 

POST

application/json

Endpoint para retornar as informações para exibir o comprovante de pagamento em Pdf

Parâmetros de entrada

Parâmetro

Obrigatório

Tipo

Descrição

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

url: https://www.operadoradesaude.com.br/mobilesaude/comprovantePdf 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

url

C

String

url do documento em .pdf

texto livre

base64

C

String

base64 do documento em .pdf

texto livre

 

Exemplo retorno API - sucesso

{ "url": "https://www.xpto.com.br/boleto/xyz.pdf", "base64": "JVBERi0xLjQKMSAwIG9iago8" }

 

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": "Comprovante de pagamento não encontrado!" }

 

Mobile Saúde - Mosia Omnichannel