Pagamento de Boleto
Recurso | Descrição |
---|---|
POST /api/v1/bank_billet_payments | Efetuar Pagamento de Boleto |
GET /api/v1/bank_billet_payments | Listar Pagamentos de Boleto |
GET /api/v1/bank_billet_payments/:id | Informações do Pagamento de Boleto |
DELETE /api/v1/bank_billet_payments/:id | Excluir Pagamento de Boleto |
Modelo de Dados
Parâmetro | Obrigatório | Tipo | Tamanho | Descrição |
---|---|---|---|---|
id | N/A | Integer | ID do Pagamento de Boleto | |
bank_billet_id | Sim | Integer | ID do Boleto | |
bank_billet_account_id | Sim | Integer | ID da Carteira | |
discharge_id | Sim | Integer | ID do Retorno | |
amount | Não | Float | Valor do Boleto | |
paid_at | Sim | Date | Data do pagamento | |
paid_amount | Sim | Float | Valor pago | |
paid_bank | Não | String | 3 | Banco de Pagamento |
paid_agency | Não | String | 5 | Agência de Pagamento |
bank_rate | Não | Float | Taxa bancária | |
credit_at | Não | Date | Data de crédito | |
direct | Não | Boolean | Pagamento direto ao beneficíario | |
expire_at | Não | Date | Data de vencimento | |
our_number | Não | Date | Nosso número | |
created_via_api | N/A | Boolean | Enviado pela API | |
created_at | Não | DateTime | Criado em | |
line_parsed | N/A | Hash/Array | Linha parseada com informações vindas do banco | |
customer_person_name | Não | String | 3 | Nome do cliente |
paid_by_pix | N/A | Boolean | Pagamento via PIX |
Efetuar Pagamento de Boleto
POST /api/v1/bank_billet_payments
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_payments'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":{"bank_billet_payment":["não pode ficar em branco"]}}
Exemplo de requisição válida
Requisição:
curl -i \ -H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \ -d '{"bank_billet_payment":{"paid_amount":40.01,"bank_rate":4,02,"paid_at":"2017-03-13","paid_bank":"001","paid_agency":"00001","bank_billet_id":1}}' \ -H 'Content-Type: application/json' \ -H 'User-Agent: MyApp (myapp@example.com)' \ -X POST 'https://api-sandbox.kobana.com.br/v1/bank_billet_payments'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/bank_billet_payments/1 Content-Type: application/json; charset=utf-8 ... { "id": 1, "paid_at": "2018-09-05", "paid_amount": 6.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "00001", "bank_billet_id": 1, "bank_billet_account_id": 2, "created_at":"2018-09-05" }
Listar Pagamentos de Boleto
GET /api/v1/bank_billet_payments
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. |
paid_from | Não | Date | A partir da Data de pagamento |
paid_to | Não | Date | Até a Data de pagamento |
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_payments?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, "paid_at": "2018-09-05", "paid_amount": 6.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "00001", "bank_billet_id": 1, "bank_billet_account_id": 2, "created_at":"2018-09-05" } ]
Informações do Pagamento de Boleto
GET /api/v1/bank_billet_payments/: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_payments/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, "paid_at": "2018-09-05", "paid_amount": 6.0, "bank_rate": 1.5, "paid_bank": "001", "paid_agency": "00001", "bank_billet_id": 1, "bank_billet_account_id": 2, "created_at": "2018-09-05" }
Excluir Pagamento de Boleto
DELETE /api/v1/bank_billet_payments/: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_payments/1'Resposta:
HTTP/1.1 204 No Content Date: Fri, 17 Oct 2014 19:30:06 GMT Status: 204 No Content ...