Retornos Bancários - inncash/inncash-docs GitHub Wiki

Introdução

Os retornos bancários são processados no Inncash, porém, por preferência é possível sincronizar os dados gerados pelo sistema com a base de dados do cliente. Haverão dois eventos responsáveis pela sincronização: Webservice para teste dos Webhooks

Patch: URL_BASE/erps

Na requisição será necessário especificar o identificador da empresa por meio do "company_id" (fornecido pela Innova no momento de implantação). Ele deverá ser enviado no header da requisição com esse formato: Company-Id: 1.

Esse webservice recebe como parâmetro o mesmo corpo de requisição que será enviada ao cliente via Webhook.

O InnCash irá fazer uma requisição ao webhook cadastrado pelo cliente via POST, e para marcar a integração como sucesso deve receber um status code 200

Retornos bancários Enviará uma matriz com quinhentas posições contendo os dados gerados pelo InnCash.

O mesmo endpoint é responsável tanto pelos retornos bancários de cobrança quanto de recebimento, divergindo somente o campo title_type_record, que fica com title_type_record = 'R' para contas a receber e title_type_record = 'P' para contas a pagar.

{
   "event":"sync_bank_payback",
   "integration_id": "2ef09fb5-2c09-4233-9b3d-0386f2741938",
   "id":null,
   "data":[
      {
         "id":"c51fc2eaa2591bdce2da5e023cce5d92",
         "action":"4",
         "bank_account":"561542",
         "bank_account_digit":"443",
         "settle_history": "Valor pago s /Titulo - INNCASH",
         "bank_agency":"354540",
         "bank_agency_digit":"854",
         "bank_code":"0051",
         "bank_low_reason":null,
         "bank_modality":null,
         "bank_occurrence":"0",
         "branch":"01",
         "cnab_bank_transactions_id":674,
         "company":"01",
         "company_token":"5e3e36aef934103164ff21847bb9a0e8",
         "date_time":"2021-12-17 14:59:36",
         "provider_account":"null",
         "provider_account_digit":"null",
         "provider_agency":"null",
         "provider_agency_digit":"null",
         "provider_auth":"null",
         "provider_bank":"null",
         "provider_barcode":"null",
         "provider_name":"null",
         "status":"0",
         "title_customer_supplier_cgc":"null",
         "title_payment_receipt_credit_date":"null",
         "title_payment_receipt_customer_supplier":"12105433323",
         "title_payment_receipt_customer_supplier_store":"0001",
         "title_payment_receipt_discount":"0",
         "title_payment_receipt_fine":"0",
         "title_payment_receipt_interest":"0",
         "title_payment_receipt_low_date":"null",
         "title_payment_receipt_number":"000671574",
         "title_payment_receipt_portion":"001",
         "title_payment_receipt_prefix":"1",
         "title_payment_receipt_type":"NF",
         "title_payment_receipt_value":"990",
         "title_payment_receive_effective_tariff":"null",
         "title_payment_receive_idcnab":"0400553582535",
         "title_payment_receive_net_value":"null",
         "title_replaces":"1",
         "title_type_record":"R"
      }
   ],
   "company_id":[15,
}

🔁 Estrutura dos campos do objeto data[]

Campo Tipo Descrição
id string Identificador único da transação.
action string Ação do evento (ex: "4" = liquidação).
bank_account string Número da conta bancária.
bank_account_digit string Dígito verificador da conta.
settle_history string Histórico da liquidação.
bank_agency string Agência bancária.
bank_agency_digit string Dígito da agência.
bank_code string Código do banco.
bank_low_reason string / null Motivo da baixa, se aplicável.
bank_modality string / null Modalidade bancária.
bank_occurrence string Código da ocorrência no banco.
branch string Código da filial da empresa.
cnab_bank_transactions_id Inteiro ID da transação na base CNAB.
company string Código da empresa.
company_token string Token de autenticação da empresa.
date_time string (datetime) Data e hora do evento.
provider_account string Conta do favorecido.
provider_account_digit string Dígito da conta do favorecido.
provider_agency string Agência do favorecido.
provider_agency_digit string Dígito da agência do favorecido.
provider_auth string Código de autorização bancária.
provider_bank string Banco do favorecido.
provider_barcode string Código de barras do título.
provider_name string Nome do favorecido.
status string Status da transação (0 = pendente).
title_customer_supplier_cgc string CPF/CNPJ do cliente ou fornecedor.
title_payment_receipt_credit_date string Data de crédito do título.
title_payment_receipt_customer_supplier string Documento do cliente/fornecedor.
title_payment_receipt_customer_supplier_store string Código da loja do cliente/fornecedor.
title_payment_receipt_discount decimal Valor de desconto.
title_payment_receipt_fine decimal Valor de multa.
title_payment_receipt_interest decimal Valor de juros.
title_payment_receipt_low_date string Data de baixa do título.
title_payment_receipt_number string Número do título.
title_payment_receipt_portion string Parcela do título.
title_payment_receipt_prefix string Prefixo identificador do título.
title_payment_receipt_type string Tipo de título (ex: "NF").
title_payment_receipt_value decimal Valor original do título.
title_payment_receive_effective_tariff decimal Tarifa efetiva aplicada.
title_payment_receive_idcnab string Identificador CNAB da transação.
title_payment_receive_net_value decimal Valor líquido recebido.
title_replaces string Indica se substitui outro título.
title_type_record string Tipo do título: "R" = a receber, "P" = a pagar.
⚠️ **GitHub.com Fallback** ⚠️