Este método é usado para buscar bolepix gerados para pagamento.
Seguem as URLs e ambientes disponíveis:
- Produção: https://api2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets/document/[cnpj]/accounts/[accountNumber]/numbers/[ourNumber]
- Homologação: https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets/document/[cnpj]/accounts/[accountNumber]/numbers/[ourNumber]
Request #
Exemplo de busca dos boletos pelo cnpj, número da conta e nosso número
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets/document/12345678912345/accounts/1234567890/numbers/00000006900' \
--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 associada ao client_id. | String | Obrigatório |
| ourNumber | Nosso número. Recebido na geração do boleto | String | Obrigatório |
| document | CNPJ da conta associada ao client_id. | String | Obrigatório |
Response #
{
"data": {
"type": "partners",
"id": 2586,
"attributes": {
"id": 8174,
"cnpj": "221644343136",
"assignorName": "EMPRESAXYZ",
"creationDate": "2023-07-03T00:00:00-03:00",
"ourNumber": "00000002586",
"yourNumber": "321456995",
"payerName": "TESTE",
"payerDocument": "94934695060",
"payerPhone": "",
"payerEmail": "",
"payerAddress": {
"publicPlace": null,
"number": null,
"complement": null,
"neighborhood": null,
"city": null,
"state": null,
"zipCode": null
},
"value": 51.50,
"liquidValue": 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==",
"txid": "CB001000191120000000667816112350101",
"qrCode": "iVBORw0KGgoAAAANSUhEUgAAA+gAAAPoAQAAAABl2OlJAAAG00lEQVR4Xu3PAY4jNxBD0b1B7n/L3CCBwBBkSZ7ZzE47CpJPwHa3VFWv/OOPm/mxH/yjQb8V9FtBvxX0W0G/FfRbQb8V9FtBvxX0W0G/FfRbQb8V9FtBvxX0W0G/FfRbQb8V9FtBvxX0W0G/FfRbQV/5/Ufnt79O1m/f6/y3utObPnrrDtd0UoH+ugJ93qOjo6Ojf0fvPk/L2+ryd2amJydTPXdCX0HfT9HR0dHR36Wv6szP99wm9bPvlOaMnq2guw4dHR0dHb3rZ9+Tej46ST7bTNX93HPQ0VfQVYuOjo5+Q1d3W6mc+3jDedt952wF/XUFOjq6K9EddPTv6P28b5K+fbLlPt9r5mwHfT9FR0dHPxX083yvQd+fW+/Ieu4zZ6Ojo+8V54TvfOZsdHT0veKc8J3PnP1v0z/K6kx9sqbqV7tmrm765KOgfxb0M+jo6OjoX9VVrQ53zgnxMj0dH52pvj8Jumq6b/66Av1j6dUZOjp6gq6a7pu/rviv6u49K/Ps6b1Xd/WGzi72G7rPU42Ojo6eifpFR/+eviIp6b7eI5V9kr28mf9HnyToCXqCPm/R0dHRv6OnSxVzSs/1c0/riv1X6ToH3efuQU8XOrpr0NHRd/Vreqbts+aczzZJ576hO2KjK+jo6Ojo6M47dM/SvX/3Z79np/x2hZPKcy66TlOrd/T92e/o7tFvVzjo6O510HWaWr3/n/Q5UWeenU5/+r5vu6N//dQ7oq+go6Ojo6O/U+971c8ez/Bd5vRGXZ0de/8EXeen5C50dPTMUy963tDR/56uCXN2TnrivkfX+8b72Dt3RlfQ0XsaOjo6+vN6fq16RuZ2RZ/7ff6Prsytg96n6Ojo6Ojoz+vOOS2nfTP3m/eJb7srQe+go++nfYOOjp77BP3neir81sJ5r9O82e1TPXcnuoPuc3S/oaOf9+h5Q/913Z2aFXOeqS7b7RP3t0zKVAd9Bd1P6dnP0NHRdw/db5mUqQ76yup6tUH6XeXa3KVv/xefb4fuU3S9oaOjuwod/Tk9tdlkP1Wln/s7b+rbZ3nP3gR9ZXfQ91NVoqOj+xwd/Sv6Sqr6bd/CtXOX3s8VnrRv6KA76Ojo6Ojor+Y9oau6zVk9vWQX+6zr5s0KuoKO7jp036OjJ+iumWdf123Yz6lm5dR1mZoKvb2aFx9dQT+r0dHR0dGf0T3FVlfH9nl26r184+feff43BX0F3RPQ0dHR0Z/X7ajL804/gusiZh/Xx8tJgq6go6Ojo6O/S0+V03P63DvNun1OvBl0BX3lVNDPc/S9bp+Djt5BV6Irq1Y9Ntfsvatv+1fPrk3f/BepRU/Q0fWOjp4q9P1Xz+hf03WqjtWjKdZ7l5ymLpmb7Pd9i97n6Ojo6Ojo79Ajt9qC5/Svn9TRs7Jn36M76Aq6PXS/oaOjP613T6ZOpbVsGdsVSdftd+gOOjo6Ojr6e3QbU0h17xDb375T5f4f7PvWQdcpOjo6+rxHR39aT2Z9bqfhk2xwunN+bPR566DrBt3nrkdHR0f/FX0mM3qSn7yZvx3b+cwN3OGgn0FHR0dHR39an9O615t45t6T52i+yTae6qA76Ojo6Ojo79FTM6f1Bj3FG6antfR397xFV9DR+wwdHR39aV1VfvZ0n8TYp/Vu6Zr3upn/DV1Bz3Pm6AQd/ZyOjv7qHv1jfcWV59wzkeZWujsnuApdQXfQX/WeQUdHR9fdOeFzXdNU5ck6SYVn9u+5cff0/XmH7ip0dAddFejo6E/qrupJ6oikfr/n9DTd2ROy+wq6TtHRfZIZ6HpDR0f3eU9zZ0/4mb5P0vmssJm3Wev/kP/SNwn6Cjr6q4m7h46+16Kj/z29HT1rC02YT7ut6p4+zQTdQVfQ84yOjo7+Hn3FXbPXuzgR/eYqbZQ+v3fioyfo6Og6PfvR/eYqdPSv64k713fqfZcpqvPO86Y1T+lp6K+Cjo7ed+ipQ0f/Fd217jhN1chJjc98r5tUe7tsmKCvoDvoe9DR0dGf0HPuZ09P/J7t8t5qanpW9lfQczuf0Tvo6Ojo6N/Te/JU1ePeeW95ftt9NcdBX0HXPfrZhY6Orhv053XVzvdMdmfUfktS333oCnpq0dHR/Y6Ortv36J6WGd7H5/Mt22bPfHtGfPQV9FSgo3syuut11m/o6F/X+9nvvUWsnGTrrovbfVNBP8/R0dHR0dGf1jvuyh5TSbXvMmXu6Cd1tI2uoGcmOjo6em79jJ4pv6LfCPqtoN8K+q2g3wr6raDfCvqtoN8K+q2g3wr6raDfCvqtoN8K+q2g3wr6raDfCvqtoN8K+q2g3wr6raDfCvqt/AnTNlz9iqjKvwAAAABJRU5ErkJggg==",
"copyAndPast": "00020101021226970014BR.GOV.BCB.PIX2575spi-h.bancosemear.com.br/qrcode/gi/v2/cobv/1d1d134a792b4f02adde7c9da8edfba95204000053039865802BR5921BANCO SEMEAR PJ TESTE6006PALMAS61080131093062070503***6304CABA",
"titleSituationPix": "2",
"originTransaction": 3,
"fineCod": 1,
"fineDate": "2024-07-01T00:00:00",
"fine": 3.89,
"interestCod": 2,
"interestDate": "2024-07-02T00:00:00",
"interest": 5.93,
"discountCod": 2,
"discountDate1": "2024-06-27T00:00:00",
"discount1": 2.00,
"discountDate2": "2024-06-28T00:00:00",
"discount2": 1.00,
"discountDate3": "2024-06-29T00:00:00",
"discount3": 3.00
}
}
}Estrutura do body (Response) #
| Propriedade | Descrição | Tipo |
|---|---|---|
| data.type | Tipo | String |
| data.id | Número do bolepix | 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 bolepix | DateTime |
| data.attributes.ourNumber | Número do nosso bolepix | 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 bolepix | decimal |
| data.attributes.liquidValue | Valor liquido pago do bolepix | decimal |
| data.attributes.dueDate | Data de vencimento do bolepix | DateTime |
| data.attributes.accountNumber | Número da conta do cedente com dígito | String |
| data.attributes.digitableLine | Linha digitável do bolepix | String |
| data.attributes.barCode | Código de barras do bolepix | String |
| data.attributes.description | Descrição | String |
| data.attributes.status | Status do bolepix | String |
| data.attributes.type | Tipo do bolepix | String |
| data.attributes.pdf | URL de download do bolepix | String |
| data.attributes.paymentLink | Link de pagamento | String |
| data.attributes.txid | Identificador gerado ao cadastrar novo bolepix. | String |
| data.attributes.qrCode | QrCode gerado quando PIX foi cadastrado com sucesso no bolepix. | String |
| data.attributes.copyAndPast | Copia e cola gerado ao cadastrar novo pix via bolepix. | String |
| data.attributes.titleSituationPix | Codigo referente ao estado do pix gerado(1 = em processamento, 2 = sucesso, 3 = falha) | String |
| data.attributes.originTransaction | Determina a origem da transação (3 = BOLEPIX) | int32 |
| data.attributes.fineCod | Código de multa do título | int32 |
| data.attributes.fineDate | Data da multa aplicada ao título | DateTime |
| data.attributes.fine | Valor/taxa de multa do título | decimal |
| data.attributes.interestCod | Código de mora/juros do título | int32 |
| data.attributes.interestDate | Data da mora/juros do título | DateTime |
| data.attributes.interest | Valor/taxa de mora/juros aplicado ao título | decimal |
| data.attributes.discountCod | Código de desconto do título | int32 |
| data.attributes.discountDate1 | Data do Primeiro desconto aplicado ao título | DateTime |
| data.attributes.discount1 | Valor/taxa do primeiro desconto aplicado ao título | decimal |
| data.attributes.discountDate2 | Data do segundo desconto aplicado ao título | DateTime |
| data.attributes.discount2 | Valor/taxa do segundo desconto aplicado ao título | decimal |
| data.attributes.discountDate3 | Data do terceiro desconto aplicado ao título | DateTime |
| data.attributes.discount3 | Valor/taxa do terceiro desconto aplicado ao título | decimal |
