Registro de Boleto
Recurso | Descrição |
---|---|
GET /api/v1/bank_billet_registrations | Listar Registros de Boleto |
GET /api/v1/bank_billet_registrations/:id | Informações do Registro de Boleto |
Modelo de Dados
Parâmetro | Obrigatório | Tipo | Tamanho | Descrição |
---|---|---|---|---|
id | N/A | Integer | ID do Registro de Boleto | |
bank_billet_id | N/A | Integer | ID do Boleto | |
bank_billet_account_id | N/A | Integer | ID da Carteira | |
status | N/A | String | Situação do registro (possíveis valores) | |
registered_at | N/A | DateTime | Data e hora do registro | |
error_message | N/A | String | Mensagem de erro do registro | |
failed_at | N/A | DateTime | Data e hora da falha | |
fails_count | N/A | Integer | Quantidade de falhas em tentativas de registrar o boleto |
Dicionário de Dados
status
0 | Erro |
1 | Sucesso |
2 | Serviço indisponível |
Listar Registros de Boleto
GET /api/v1/bank_billet_registrations
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) |
bank_billet_id | Não | Number | ID do Boleto. |
bank_billet_account_id | Não | Number | ID da Carteira. |
registered_from | Não | Date | A partir da Data de registro |
registered_to | Não | Date | Até a Data de registro |
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_registrations?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": 1, "bank_billet_id": 1, "bank_billet_account_id": 2, "created_at":"2018-09-05", "error_message":nil, "failed_at":nil, "fails_count":0, "registered_at":"2018-09-10", "status":"01" } ]
Informações do Registro de Boleto
GET /api/v1/bank_billet_registrations/:id
Exemplo
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_registrations/1'Resposta:
HTTP/1.1 200 OK Date: Fri, 17 Oct 2014 19:46:16 GMT Status: 200 OK Content-Type: application/json; charset=utf-8 ... { "id": 1, "bank_billet_id": 1, "bank_billet_account_id": 2, "created_at":"2018-09-05", "error_message":nil, "failed_at":nil, "fails_count":0, "registered_at":"2018-09-10", "status":"01" }