Registro de Retorno

Informações do Registro de Retorno

Consulta informações específicas de um Registro de Retorno.

get/v1/bank_billet_discharges/{id}

Request

Base URL
https://api-sandbox.kobana.com.br
Auth
HTTP bearer
TypeScript
https://skmtc.dev/kobana/apis/cobran-as/docs/v1/bank_billet_discharges/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

ID do Registro de Retorno

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Registro de Retorno encontrado

idinteger

ID do Registro de Retorno

our_occurrence'2001' | '2002' | '2003' | '2004' | '2005' | '2006' | '2007' | '2008' | '2009' | '2010' | '2011' | '2012' | '2013' | '2014' | '2015' | '2016' | '2017' | '2018' | '2019' | '2020' | '2021' | '2022' | '2023' | '2024' | '2025' | '2026' | '2027' | '2028' | '2029' | '2030' | '2031' | '2032' | '2033' | '2034' | '2035' | '2036' | '2037' | '2038' | '2039' | '2040' | '2041' | '2042' | '2043' | '2044' | '2045' | '2046' | '2047' | '2048' | '2049' | '2050' | '2051' | '2052' | '2053' | '2054' | '2055' | '2056' | '2057' | '2058' | '2059' | '2060' | '2061' | '2062' | '2063' | '2064' | '2065' | '2066' | '2067' | '2068' | '2069' | '2070' | '2071' | '2072' | '2073' | '2074' | '2075' | '2076' | '2077' | '2078' | '2079' | '2080' | '2081' | '2082' | '2083' | '2084' | '2085' | '2086' | '2087' | '2088' | '2089' | '2090' | '2091' | '2092' | '2093' | '2094' | '2095' | '2096' | '2097' | '2098' | '2099' | '2100' | '2101' | '2102' | '2103' | '2104' | '2105' | '2106' | '2107' | '2108' | '2109' | '2110' | '2111' | '2112' | '2113' | '2114' | '2115' | '2116' | '2117' | '2118' | '2119' | '2120' | '2121' | '2122' | '2123' | '2124' | '2125' | '2126' | '2127' | '2128' | '2129' | '2130' | '2131' | '2132' | '2133' | '2134' | '2135' | '2136' | '2137' | '2138' | '2139' | '2140' | '2141' | '2142' | '2143' | '2144' | '2145' | '2146' | '2147' | '2148' | '2149' | '2150' | '2151' | '2152' | '2153' | '2154' | '2155' | '2156' | '2157' | '2158' | '2159' | '2160' | '2161' | '2162' | '2163' | '2164' | '2165' | '2166' | '2167' | '2168' | '2169' | '2170' | '2171' | '2172' | '2173' | '2174' | '2175' | '2176' | '2177' | '2178' | '2179' | '2180' | '2181' | '2182' | '2183' | '2184' | '2185' | '2186' | '2187' | '2188' | '2189' | '2190' | '2191' | '2192' | '2193' | '2194' | '2195' | '2196' | '2197' | '2198' | '2199' | '2200' | '2201' | '2202' | '2203' | '2204' | '2205' | '2206' | '2207' | '2208' | '2209' | '2210' | '2211' | '2212' | '2213' | '2214' | '2215' | '2216' | '2217' | '2218' | '2219' | '2220' | '2221' | '2222' | '2223' | '2224' | '2225' | '2226' | '2227' | '2228' | '2229' | '2230' | '2231' | '2232' | '2233' | '2234' | '2235' | '2236' | '2237' | '2238' | '2239' | '2240' | '2241' | '2242' | '2243' | '2244' | '2245' | '2246' | '2247' | '2248' | '2249' nullable

Código único de operação dentro da Kobana.

Código	Descrição
2001	Entrada Confirmada
2002	Entrada Rejeitada
2003	Liquidação
2004	Baixa de Título Confirmada
2005	Baixa de Título Rejeitada
2006	Alteração do Vencimento Confirmada
2007	Alteração do Vencimento Rejeitada
2008	Baixa Solicitada
2009	Títulos em Carteira (em ser)
2010	Confirmação de Recebimento de Instrução de Abatimento
2011	Confirmação de Recebimento de Instrução de Cancelamento Abatimento
2012	Confirmação de Recebimento de Instrução de Alteração de Vencimento
2013	Franco de Pagamento
2014	Liquidação Após Baixa ou Liquidação Título Não Registrado
2015	Confirmação Recebimento Instrução de Protesto
2016	Confirmação Recebimento Instrução de Sustação/Cancelamento de Protesto
2017	Remessa a Cartório (Aponte em Cartório)
2018	Retirada de Cartório e Manutenção em Carteira
2019	Protestado e Baixado (Baixa por ter sido Protestado)
2020	Instrução Rejeitada
2021	Confirmação do Pedido de Alteração de Outros Dados
2022	Débito de Tarifas/Custas
2023	Ocorrências do Sacado
2024	Alteração de Dados Rejeitada
2025	Título pago com cheque devolvido
2026	Título pago com cheque pendente de compensação
2027	Liquidado sem registro
2028	Liquidação Normal
2029	Liquidação por Conta/Parcial
2030	Liquidação por Saldo
2031	Transferência de Carteira/Entrada
2032	Transferência de Carteira/Baixa
2033	Abatimento Concedido
2034	Abatimento Cancelado
2035	Liquidação em Cartório
2036	Confirmação de alteração de juros de mora
2037	Débito em Conta
2038	Alteração do Nome do Sacado
2039	Alteração do Endereço do Sacado
2040	Indicação de encaminhamento a cartório
2041	Sustar Protesto
2042	Dispensar Juros de mora
2043	Alteração do número do título dado pelo Cedente (Seu número) – 10 e 15 posições
2044	Manutenção de título vencido
2045	Conceder desconto
2046	Não conceder desconto
2047	Retificar desconto
2048	Alterar data para desconto
2049	Cobrar Multa
2050	Dispensar Multa
2051	Dispensar Indexador
2052	Dispensar prazo limite para recebimento
2053	Alterar prazo limite para recebimento
2054	Alteração do número do controle do participante (25 posições)
2055	Alteração do número do documento do sacado (CNPJ/CPF)
2056	Alteração de tipo de cobrança (específico para títulos das carteiras 11 e 17)
2057	Confirmação de Instrução de Parâmetro de Pagamento Parcial
2058	Despesas de Protesto
2059	Despesas de Sustação de Protesto
2060	Débito de Custas Antecipadas
2061	Confirmação do recebimento da instrução de desconto
2062	Confirmação do recebimento do cancelamento do desconto
2063	Solicitação de 2a via de instrumento de protesto
2064	2a via de instrumento de protesto emitida pelo cartório
2065	Confirmação da alteração dos dados do sacado
2066	Confirmação da alteração dos dados do sacador avalista
2067	Título DDA reconhecido pelo sacado
2068	Título DDA não reconhecido pelo sacado
2069	Título DDA recusado pela CIP
2070	Instrução de protesto processada
2071	Remessa rejeitada
2072	Baixa de título liquidado por edital
2073	Devolução automática
2074	Baixado conforme instruções
2075	Arquivo levantamento
2076	Pagamento em cartório
2077	Alteração de dados
2078	Alteração de instruções
2079	Aguardando autorização para protesto por edital
2080	Protesto sustado por alteração de vencimento e prazo de cartório
2081	Confirmação da entrada em cartório
2082	cobrança a creditar (liquidação em trânsito)
2083	Título em trânsito pago em cartório
2084	Reembolso e transferência Desconto e Vendor ou carteira em garantia
2085	Reembolso e devolução Desconto e Vendor
2086	Reembolso não efetuado por falta de saldo
2087	Despesa de aponte
2088	Alteração de título
2089	Relação de títulos
2090	Manutenção mensal
2091	Sustação de cartório e envio de título a cartório
2092	Fornecimento de formulário pré-impresso
2093	Confirmação de entrada – Pagador DDA
2094	Acerto dos dados do rateio de crédito
2095	Cancelamento dos dados do rateio
2096	Pagamento por Conta
2097	Baixa Simples
2098	Devolvido - Protestado
2099	Baixa automática
2100	Alteração Depositária
2101	Confirmação de Protesto
2102	Título Pago em Cheque – Vinculado
2103	Acerto de Depositária
2104	Acerto do Controle do Participante
2105	Título Com Pagamento Cancelado
2106	Entrada rejeitada por CEP Irregular
2107	Confirmação Receb.Inst.de Protesto Falimentar
2108	Ocorrências do Pagador
2109	Retirado de Cartório e Manutenção Carteira
2110	Desagendamento do débito automático
2111	Estorno de pagamento
2112	Sustado judicial
2113	Solicitação de Impressão de Títulos Confirmada
2114	Confirmação de Inclusão Banco de Pagador
2115	Confirmação de Alteração Banco de Pagador
2116	Confirmação de Exclusão Banco de Pagador
2117	Emissão de Boletos de Banco de Pagador
2118	Manutenção de Pagador Rejeitada
2119	Entrada de Título via Banco de Pagador Rejeitada
2120	Manutenção de Banco de Pagador Rejeitada
2121	Estorno de Baixa / Liquidação
2122	Liquidação On-line
2123	Estorno de Liquidação On-line
2124	Confirmação de alteração do valor nominal do título
2125	Confirmação de alteração do valor/percentual mínimo/máximo
2126	Baixa Manual Confirmada
2127	Uso da Empresa Alterado
2128	Prazo de Protesto Alterado
2129	Prazo de Devolução Alterado
2130	Alteração com reemissão de Bloqueto Confirmada
2131	Alteração da opção de Protesto para Devolução Confirmada
2132	Alteração da opção de Devolução para Protesto Confirmada
2133	Baixa por Devolução
2134	Título enviado para Cartório
2135	Estorno de Protesto
2136	Estorno de Sustação de Protesto
2137	Tarifa sobre Título Vencido
2138	Outras Tarifas de Alteração
2139	Tarifas Diversas
2140	Rejeição do Título
2141	Confirmação de Envio de SMS
2142	Envio de SMS rejeitado
2143	Cancelamento de SMS
2144	Liquidação de boleto cooperativa emite e expede
2145	Liquidação de boleto após baixa ou não registrado cooperativa emite e expede
2146	Título em aberto não enviado ao pagador
2147	Inconsistência Negativação Serasa
2148	Inclusão Negativação via Serasa
2149	Exclusão Negativação Serasa
2150	Devolução por Decurso de Prazo
2151	Confirmação de Pedido de Exclusão da Serasa
2152	Título enviado para negativação
2153	Alegação do Sacado
2154	Título retirado de cartório
2155	Custa de distribuição
2156	Custa de sustação
2157	Custa de protesto
2158	Movimentação CIP
2159	Alteração De Dados – Nova Entrada ou Alteração/Exclusão de Dados Acatada
2160	Alteração de Dados – Baixa
2161	Baixa Por Ter Sido Liquidado
2162	Cobrança Contratual – Instruções/Alterações Rejeitadas/Pendentes
2163	Confirmação Recebimento de Instrução de Não Protestar
2164	Protesto Enviado a Cartório/Tarifa
2165	Tarifa de Aviso de Cobrança
2166	Tarifa de Extrato Posição
2167	Tarifa de Relação das Liquidações
2168	Tarifa de Manutenção de Títulos Vencidos
2169	Débito Mensal de Tarifas (para entradas e baixas)
2170	Custas de Edital
2171	Tarifa de Emissão de Boleto/Tarifa de Envio de Duplicata
2172	Tarifa de Instrução
2173	Tarifa de Ocorrências
2174	Tarifa Mensal de Emissão de Boleto/Tarifa Mensal de Envio de Duplicata
2175	Débito Mensal de Tarifas – Extrato de Posição (b4ep/b4ox)
2176	Débito Mensal de Tarifas – Outras Instruções
2177	Débito Mensal de Tarifas – Manutenção de Títulos Vencidos
2178	Débito Mensal de Tarifas – Outras Ocorrências
2179	Débito Mensal de Tarifas – Protesto
2180	Débito Mensal de Tarifas – Sustação de Protesto
2181	Baixa Com Transferência Para Desconto
2182	Custas de Sustação Judicial
2183	Tarifa Mensal Referente A Entradas Bancos Correspondentes Na Carteira
2184	Tarifa Mensal Baixas Na Carteira
2185	Tarifa Mensal Baixas Em Bancos Correspondentes Na Carteira
2186	Tarifa Mensal de Liquidações Na Carteira
2187	Tarifa Mensal de Liquidações Em Bancos Correspondentes Na Carteira
2188	Custas de Irregularidade
2189	Instrução Cancelada
2190	Comando Recusado
2191	Código de IOF inválido
2192	Título não existe
2193	Prorrogação de Vencimento
2194	Título Já Baixado/Protestado
2195	Custas de Cartório
2196	Confirmação de envio de e-mail/SMS
2197	Envio de e-mail/SMS rejeitado
2198	Título pago com cheque compensado
2199	Instrução para protesto para fins falimentares confirmada
2200	Alteração de contrato de cobrança
2201	Confirmação da Instrução de Baixa de Título Negativado sem Protesto
2202	Confirmação de Pedido de Dispensa de Multa
2203	Confirmação do Pedido de Cobrança de Multa
2204	Confirmação do Pedido de Alteração de Cobrança de Juros
2205	Confirmação do Pedido de Alteração do Valor/Data de Desconto
2206	Confirmação do Pedido de Alteração do Beneficiário do Título
2207	Confirmação do Pedido de Dispensa de Juros de Mora
2208	Confirmação de instrução de transferência de carteira/modalidade de cobrança
2209	Confirmação de Desistência de Protesto
2210	Encaminhado a Protesto
2211	Baixado automaticamente via arquivo
2212	Baixa rejeitada
2213	Tarifa
2214	Rejeição do pagador
2215	Alteração rejeitada
2216	Aceite do Pagador
2217	Baixa por Crédito em Conta Corrente
2218	Entrada Rejeitada Carnê
2219	Tarifa Emissão Aviso de Movimentação de Títulos
2220	Débito Mensal de Tarifas - Aviso de Movimentação de Títulos
2221	Entrada Confirmada com Rateio de Crédito
2222	Baixa por Crédito em Conta Corrente sem Título Correspondente
2223	Confirmação de Entrada na Cobrança
2224	Instrução de Negativação Expressa Rejeitada
2225	Confirma o Recebimento de Instrução de Entrada Em Negativação Expressa
2226	Confirma o Recebimento de Instrução de Exclusão de Entrada Em Negativação Expressa
2227	Confirma o Recebimento de Instrução de Cancelamento de Negativação Expressa
2228	Negativação Expressa Informacional
2229	Confirma de Entrada Em Negativação Expressa / Tarifa
2230	Confirma o Cancelamento Em Negativação Expressa / Tarifa
2231	Confirma Exclusão de Entrada Em Negativação Expressa Por Liquidação / Tarifa
2232	Tarifa Pacote Cobrança Ativa Eletrônica
2233	Tarifa E-mail Cobrança Ativa Eletrônica
2234	Tarifa Sms Cobrança Ativa Eletrônica
2235	Tarifa Mensal Pacote Cobrança Ativa Eletrônica
2236	Tarifa Mensal E-mail Cobrança Ativa Eletrônica
2237	Tarifa Mensal Sms Cobrança Ativa Eletrônica
2238	Tarifa Mensal de Exclusão de Entrada Em Negativação Expressa
2239	Tarifa Mensal de Cancelamento de Negativação Expressa
2240	Tarifa Mensal de Exclusão de Negativação Expressa Por Liquidação
2241	Confirma Recebimento de Instrução de Não Negativar
2242	Transferência de Beneficiário
2243	Baixa de Título Protestado
2244	Despesa de Cartório
2245	Acerto de Data de Emissão
2246	Acerto de Código de Espécie Documento
2247	Instrução Negativação Aceita
2248	Instrução Baixa de Negativação Aceita
2249	Instrução Não Negativar Aceita

discharge_idinteger nullable

ID do Retorno.

bank_billet_idinteger nullable

ID do Boleto.

processed_atstring date-time nullable

Data de Processamento.

date_of_occurrencestring date nullable

Data da ocorrência.

occurrencestring nullable

Código da operação no banco.

occurrence_detailstring nullable

Descrição do evento no Retorno.

occurrence_errorstring nullable

Erro no retorno.

occurrence_error_detailstring nullable

Descrição do erro no retorno.

line_rawstring json nullable

Linha plana com informações vindas do banco.

line_parsedstring json nullable

Linha parseada com informações vindas do banco:

Conteúdo do retorno bancário. Pode mudar de acordo com o banco e o formato 240 ou 400. Se algum dos campos estiver em branco é porque o seu banco não disponibiliza essa informação.

Valor	Descrição
paid_at	Data de pagamento
paid_amount	Valor pago
bank_rate	Taxa do boleto paga ao banco
credit_at	Data de crédito
credit_amount	Valor do Crédito
our_number	Nosso número
processed_our_number_raw	Nosso número formatado
discount	Desconto
billet_fine	Acréscimos(Multa/Juros cobrados)
other_fines	Outras cobranças adicionais
other_credit	Outros valores pagos
value_rebate	Outras taxas
error_code	Código de erro
event_type	Ocorrência bancária
agency_number	Agência
account_number	Conta
banco_recebedor	Banco recebedor
agencia_recebedora	Agência recebedora
control_number	Número de Controle
document_number	Número do Documento

created_atstring date-time nullable

Data e hora de criação do registro

updated_atstring date-time nullable

Data e hora da última atualização do registro

Changes

No recorded changes to this operation across all 1 revision of this API.