Registro de Remessa
Recurso | Descrição |
---|---|
GET /api/v1/bank_billet_remittances | Listar Registros de Remessa |
GET /api/v1/bank_billet_remittances/pending | Listar Registros de Remessa pendentes |
POST /api/v1/bank_billet_remittances/:id/occurrence/:code | Criar pendências |
DELETE /api/v1/bank_billet_remittances/:id | Excluir pendências |
Modelo de Dados
Parâmetro | Obrigatório | Tipo | Tamanho | Descrição |
---|---|---|---|---|
id | N/A | Integer | ID do Registro de Remessa | |
our_code | Sim | String | 6 | Código de operação de registro. Consulte os possíveis valores para cada banco. |
occurrence | Não | String | 3 | Ocorrência |
remittance_id | Sim | Integer | ID da Remessa | |
bank_billet_id | Sim | Integer | ID do Boleto | |
bank_billet_account_id | Sim | Integer | ID da Carteira | |
processed_at | Não | DateTime | Quando foi processado | |
occurrence_detail | Não | String | Descrição do evento na Remessa |
Listar Registros de Remessa
GET /api/v1/bank_billet_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) |
our_code | Não | String | Código de operação de registro. Consulte os possíveis valores para cada banco. |
bank_billet_account_id | Não | Number | ID da Carteira |
remittance_id | Não | Number | ID da Remessa |
bank_billet_id | Não | Number | ID do Boleto |
expire_from | Não | Date | A partir de Data de vencimento |
expire_to | Não | Date | Até Data de vencimento |
Exemplo de requisição válida
Requisição:
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/bank_billet_remittances?page=1&per_page=50'Resposta:
Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Total: 1 Content-Type: application/json; charset=utf-8 ... [ { "id":47, "our_code": "1001", "occurrence": "01", "remittance_id":null, "bank_billet_id":46, "bank_billet_account_id":2, "processed_at":null, "occurrence_detail": "Entrada de Título", "created_at": "2017-11-21", "bank_billet":{ "id":46, "expire_at": "2017-12-26", "paid_at":null, "description": "teste", "status": "opened", ... } } ]
Listar Registros de Remessa pendentes
GET /api/v1/bank_billet_remittances/pending
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) |
our_code | Não | String | Código de operação de registro. Consulte os possíveis valores para cada banco. |
bank_billet_account_id | Não | Number | ID da Carteira |
remittance_id | Não | Number | ID da Remessa |
bank_billet_id | Não | Number | ID do Boleto |
expire_from | Não | Date | A partir de Data de vencimento |
expire_to | Não | Date | Até Data de vencimento |
Exemplo de requisição válida
Requisição:
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/bank_billet_remittances/pending?page=1'Resposta:
Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Total: 1 Content-Type: application/json; charset=utf-8 ... [ { "id":40, "our_code": "1001", "occurrence": "01", "remittance_id":null, "bank_billet_id":46, "bank_billet_account_id":2, "processed_at":null, "occurrence_detail": "Entrada de Título", "created_at": "2017-11-21", "bank_billet":{ "id":46, "expire_at": "2017-12-26", "paid_at":null, "description": "teste", "status": "opened", ... } } ]
Criar pendências
POST /api/v1/bank_billet_remittances/:id/occurrence/:our_code
Parâmetro | Obrigatório | Tipo | Descrição |
---|---|---|---|
id | Sim | Number | ID do boleto |
our_code | Não | String | Código de operação de registro. Consulte os possíveis valores para cada banco. |
Exemplo de requisição inválida
Requisição:
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/bank_billet_remittances/2/occurrence/9989x'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": "Operação não disponível para este banco."}
Exemplo de requisição válida
Requisição:
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/bank_billet_remittances/2/occurrence/1034'Resposta:
HTTP/1.1 201 Created Server: Cowboy Connection: keep-alive Strict-Transport-Security: max-age=2592000 Content-Type: application/json; charset=utf-8 ... { message: "Boleto 2 - Operação( Pago diretamente ao beneficiário ) colocado(a) na lista de envio para o banco." }
Excluir pendências
DELETE /api/v1/bank_billet_remittances/:id
Exemplo
Requisição:
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X DELETE 'https://api-sandbox.kobana.com.br/v1/bank_billet_remittances/1'Resposta:
HTTP/1.1 204 No Content Date: Fri, 17 Oct 2014 19:30:06 GMT Status: 204 No Content ...