CNAB (Remessa)
Recurso | Descrição |
---|---|
POST /api/v1/remittances | Criar CNAB |
GET /api/v1/remittances/:id | Informações do CNAB |
GET /api/v1/remittances | Listar CNABs |
DELETE /api/v1/remittances/:id | Apagar CNAB |
GET /api/v1/remittances/:id/raw | Raw(text/plain) do CNAB |
POST /api/v1/remittances/bulk | Criar CNABs em lote |
Modelo de Dados
Parâmetro | Obrigatório | Tipo | Tamanho | Descrição |
---|---|---|---|---|
id | N/A | Integer | ID do CNAB | |
content | Não | Text | Conteúdo da remessa | |
filename | Não | String | 255 | Nome do arquivo |
processed_at | Não | Time | Data de Processamento | |
created_via_api | Não | Boolean | Enviado pela API | |
status | Não | String | Situação do arquivo (possíveis valores) | |
created_at | Não | DateTime | Data e hora de criação | |
url | Não | String | URL do arquivo de remessa | |
bank_billet_account_id | Sim | Integer | ID da Carteira de Cobrança | |
bank_billet_ids | Não | Array | IDs de boletos | |
remittance_number | Não | Integer | Número da remessa | |
sent_via_integration | Não | DateTime | Data e hora de envio automático para o banco | |
bank_billet_remittance_ids | Não | Array | IDs de Registros de Remessa |
Dicionário de Dados
status
unprocessed | Pendente |
processed | Processado |
sent | Enviada para o banco (Somente quando contratado envio automático) |
Criar CNAB
POST /api/v1/remittances
Será feita uma solicitação de Remessa. Após a criação da Remessa, ela será processada e ao término do processamento serão emitidas notificações através dos Webhooks.
Exemplo de requisição inválida
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X POST 'https://api-sandbox.kobana.com.br/v1/remittances'Resposta:
HTTP/1.1 422 Unprocessable Entity Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Content-Type: application/json; charset=utf-8 ... {"errors":{"remittance":["não pode ficar em branco"]}}
Exemplo de requisição válida
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -d '{"remittance":{"bank_billet_account_id": "1"}}' \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X POST 'https://api-sandbox.kobana.com.br/v1/remittances'Resposta:
HTTP/1.1 201 Created Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Location: https://api-sandbox.kobana.com.br/v1/remittances/1 Content-Type: application/json; charset=utf-8 ... { "filename" => "1605061.REM", "created_via_api" => true, "status" => "processed", "bank_billet_account_id" => 1, "created_at" => "2016-05-06", "processed_at" => "2016-05-06", "url" => "https://app-sandbox.kobana.com.br/remessas/06tt1bcc3f6132720866b53a57c76de4/download", "id" => 1, "bank_billet_ids" => [1] }
Criar CNABs em lote
POST /api/v1/remittances/bulk
Serão feitas solicitações de Remessa de acordo com IDs das ocorrências. Será criada uma solicitação de Remessa para cada carteira associada às ocorrências. Após a criação das Remessas, elas serão processadas e ao término do processamento serão emitidas notificações através dos Webhooks.
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
bank_billet_remittance_ids | Sim | Number | IDs das Ocorrências pendentes |
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -d '{"remittance":{"bank_billet_remittance_ids":["1","2"]}}' \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X POST 'https://api-sandbox.kobana.com.br/v1/remittances/bulk'Resposta:
HTTP/1.1 200 OK Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Content-Type: application/json; charset=utf-8 ... [ { "filename" => "1605061.REM", "created_via_api" => true, "status" => "processed", "bank_billet_account_id" => 1, "created_at" => "2016-05-06", "processed_at" => "2016-05-06", "url" => "https://app-sandbox.kobana.com.br/remessas/06tt1bcc3f6132720866b53a57c76de4/download", "id" => 1, "bank_billet_ids" => [1] } ]
Informações do CNAB
GET /api/v1/remittances/:id
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X GET 'https://api-sandbox.kobana.com.br/v1/remittances/1'Resposta:
HTTP/1.1 200 OK Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Content-Type: application/json; charset=utf-8 ... { "filename" => "1605061.REM", "created_via_api" => true, "status" => "processed", "bank_billet_account_id" => 1, "created_at" => "2016-05-06", "processed_at" => "2016-05-06", "url" => "https://app-sandbox.kobana.com.br/remessas/06tt1bcc3f6132720866b53a57c76de4/download", "id" => 1, "bank_billet_ids" => [1] }
Listar CNABs
GET /api/v1/remittances
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
page | Não | Number | Número da Página |
per_page | Não | Number | Quantidade de registros por página (Máximo de 50) |
expire_from | Não | Date | A partir da Data de vencimento do boleto |
expire_to | Não | Date | Até a Data de vencimento do boleto |
created_from | Não | Date | A partir da Data de criação do Retorno |
created_to | Não | Date | Até a Data de criação do Retorno |
our_code | Não | String | Filtro por Nosso número. |
bank_billet_account_id | Não | Number | Filtro por ID da Carteira. |
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X GET "https://api-sandbox.kobana.com.br/v1/remittances?page=1&per_page=50"Resposta:
HTTP/1.1 200 OK Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Total: 1 Content-Type: application/json; charset=utf-8 ... [ { "filename" => "1605061.REM", "created_via_api" => true, "status" => "processed", "bank_billet_account_id" => 1, "created_at" => "2016-05-06", "processed_at" => "2016-05-06", "url" => "https://app.kobana.com.br/remessas/06tt1bcc3f6132720866b53a57c76de4/download", "id" => 1, "bank_billet_ids" => [1] } ]
Apagar CNAB
DELETE /api/v1/remittances/:id
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X DELETE 'https://api-sandbox.kobana.com.br/v1/remittances/11'Resposta:
HTTP/1.1 204 No Content Content-Length: 0 Connection: keep-alive Status: 204 No Content Cache-Control: no-cache X-Ratelimit-Limit: 500 Date: Thu, 27 Aug 2015 22:59:30 GMT Strict-Transport-Security: max-age=2592000 X-Ratelimit-Remaining: 498 X-Request-Id: 835c6f5c-06f3-4a8d-9cf0-a354e237cce4 X-Runtime: 0.076245 X-Rack-Cache: invalidate, pass
Raw(text/plain) do CNAB
GET /api/v1/remittances/:id/raw
Será disparado o evento remittance.downloaded
.
Exemplo
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'Content-Type: text/plain' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X GET 'https://api-sandbox.kobana.com.br/v1/remittances/1/raw'Resposta:
HTTP/1.1 200 OK Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Content-Type: application/json; charset=utf-8 ... 01REMESSA01COBRANCA 2342567888 NOME EMPRESA 104C ECON FEDERAL 240517 ...