Este método é usado para buscar boletos gerados para pagamento.
Seguem as URLs e ambientes disponíveis:
- Produção: https://api2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/[accountNumber]
- Homologação: https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/[accountNumber]
Request #
Exemplo de busca dos boletos pelo número da conta
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/10023551?pageNumber=1&pageSize=50' \
--location \
--request GET \
--header 'accept: */*' \
--header 'client_id: 999abf99-999f-9999-b9ff-9a9999ce9a99' \
--header 'access_token: 9c9999d9-d99c-999f-9999-b9fd9a99bf99'
Exemplo de busca do boleto através do seu número
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/10023551?yourNumber=4654965&pageNumber=1&pageSize=50' \
--location \
--request GET \
--header 'accept: */*' \
--header 'client_id: 999abf99-999f-9999-b9ff-9a9999ce9a99' \
--header 'access_token: 9c9999d9-d99c-999f-9999-b9fd9a99bf99'
Exemplo de busca dos boletos pela data de criação
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/10023551?creationDate=2022-07-11&pageNumber=1&pageSize=50' \
--location \
--request GET \
--header 'accept: */*' \
--header 'client_id: 999abf99-999f-9999-b9ff-9a9999ce9a99' \
--header 'access_token: 9c9999d9-d99c-999f-9999-b9fd9a99bf99'
Exemplo de busca dos boletos pela data de vencimento
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/10023551?dueDate=2022-08-25&pageNumber=1&pageSize=50' \
--location \
--request GET \
--header 'accept: */*' \
--header 'client_id: 999abf99-999f-9999-b9ff-9a9999ce9a99' \
--header 'access_token: 9c9999d9-d99c-999f-9999-b9fd9a99bf99'
Estrutura do request #
Header
- access_token: Token recebido do método oAuth (API Gateway);
- client_id: ID de cliente recebido do Banco Semear no momento do cadastro.
Parâmetros GET
Propriedade | Descrição | Tipo | Obrigatoriedade |
---|---|---|---|
accountNumber | Número da conta | int32 | Obrigatório |
yourNumber | Seu número. Informado na geração do boleto | int32 | Opcional |
creationDate | Retorna todos os boletos criados a partir da data. Formato: YYYY-MM-DD | DateTime | Opcional |
endCreationDate | Retorna todos os boletos criados até a data. Formato: YYYY-MM-DD | DateTime | Opcional |
dueDate | Retorna todos os boletos vencidos a partir da data. Formato: YYYY-MM-DD | DateTime | Opcional |
endDueDate | Retorna todos os boletos vencidos até a data. Formato: YYYY-MM-DD | DateTime | Opcional |
status | Consulta os boletos pelo status. Formato: inteiro (1 – Em Aberto, 2- Em Cartório, 3 – Pago, 4 – Pago, 5 – Baixado, 6 – Protestado, 7- Vencido) | int32 | Opcional |
pageNumber | Número da página do response (Default: 1) | int32 | Opcional |
pageSize | Número de elementos no response (Default: 50) | int32 | Opcional |
Response #
{
"meta": {
"totalPages": 2,
"totalRegisters": 69
},
"data": [
{
"type": "partners",
"id": 2586,
"attributes": {
"id": 8174,
"cnpj": "221644343136",
"payerName": "TESTE",
"payerDocument": "94934695060",
"payerPhone": "",
"payerEmail": "",
"payerAddress": {
"publicPlace": null,
"number": null,
"complement": null,
"neighborhood": null,
"city": null,
"state": null,
"zipCode": null
},
"assignorName": "EMPRESAXYZ",
"creationDate": "2023-07-03T00:00:00-03:00",
"ourNumber": "00000002586",
"yourNumber": "321456995",
"value": 51.50,
"dueDate": "2023-07-17T00:00:00-03:00",
"accountNumber": 10029559,
"digitableLine": "74390001131200000370200000025866994140000005150",
"barcode": "74399941400000051500001112000003700000002586",
"description": "Mensagem personalizada",
"status": "Em Aberto",
"type": 2,
"pdf": "https://awshmllbgw.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/10032229/numbers/00000007777/downloads",
"paymentLink": "https://hml-semearpay.bancosemear.com.br/pay/boleto/gR_5TD4LTSQJvmBRiRz_7ArRfIi3434UsKebWa5_py4yL9Rt91JQElmXFDIR_M4H3-mAMSa4p7Qq343362MQOg==" }
}
]
}
Estrutura do body (Response) #
Propriedade | Descrição | Tipo |
---|---|---|
data.type | Tipo | String |
data.id | Número do boleto | int32 |
data.attributes.id | Id interno Semear | String |
data.attributes.cnpj | CNPJ do cedente | String |
data.attributes.assignorName | Nome do cedente | String |
data.attributes.creationDate | Data de criação do boleto | DateTime |
data.attributes.ourNumber | Número do boleto | String |
data.attributes.yourNumber | Seu número (Número informado na request) | String |
data.attributes.payerName | Nome do pagador | String |
data.attributes.payerDocument | Documento do pagador | String |
data.attributes.payerPhone | Telefone do pagador | String |
data.attributes.payerEmail | Email do pagador | String |
data.attributes.payerAddress.publicPlace | Rua do pagador | String |
data.attributes.payerAddress.number | Numero da residencia do pagador | String |
data.attributes.payerAddress.complement | Complemento do endereco do pagador | String |
data.attributes.payerAddress.neighborhood | Bairro do pagador | String |
data.attributes.payerAddress.city | Cidade do pagador | String |
data.attributes.payerAddress.state | Estado do pagador | String |
data.attributes.payerAddress.zipCode | CEP do pagador | String |
data.attributes.value | Valor do boleto | decimal |
data.attributes.liquidValue | Valor liquido pago do boleto | decimal |
data.attributes.dueDate | Data de vencimento do boleto | DateTime |
data.attributes.accountNumber | Número da conta do cedente | String |
data.attributes.digitableLine | Linha digitável do boleto | String |
data.attributes.barCode | Código de barras do boleto | String |
data.attributes.description | Descrição | String |
data.attributes.status | Status do boleto | String |
data.attributes.type | Tipo do boleto | String |
data.attributes.pdf | URL de download do boleto | String |
data.attributes.paymentLink | Link de pagamento | String |