Este método é usado para buscar bolepix gerados para pagamento.
Seguem as URLs e ambientes disponíveis:
- Produção: https://api2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/[correlationId]/account/[account]
- Homologação: https://hmlapi2.bancosemear.com.br//paas-billet-api/api/v1/public/paas-billets/[correlationId]/account/[account]
Request #
Exemplo de busca dos boletos pelo cnpj, número da conta e nosso número
curl 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/02d65876-59d0-446a-bee7-7195fb852ce0/account/1234567890' \
--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 #
{
"correlationId": "02d65876-59d0-446a-bee7-7195fb852ce0",
"assignorDocument": "58380727000121",
"assignorName": "Silvio Desenvolvedor LTDA",
"payerName": "Kari",
"payerDocument": "85027978081",
"payerPhone": "21999889999",
"payerEmail": "Ramon_Medhurst@hotmail.com",
"payerAddress": {
"publicPlace": "12345678901234567890123456789012345678901234567890",
"number": "12345",
"complement": "12345678901234567890123456789012345678901234567890",
"neighborhood": "1234567890123456789012345678901234567890",
"city": "Palmas",
"state": "MG",
"zipCode": "12345678"
},
"creationDate": "2024-08-05T14:39:57",
"ourNumber": "00000044737",
"yourNumber": "123456789012345",
"value": 633.15,
"liquidValue": 0.00,
"dueDate": "2024-08-05T00:00:00",
"operationDate": "2024-08-05T14:39:46",
"accountNumber": 110380071,
"digitableLine": "74390001131200000880000000447375197990000063315",
"barcode": "74391979900000633150001112000008800000044737",
"description": "123456789012345678901234567890123456789012345678901234567890123456789012345678",
"status": "Vencido",
"pdf": "https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/02d65876-59d0-446a-bee7-7195fb852ce0/account/0110380071/downloads",
"paymentLink": "https://hml-semearpay.bancosemear.com.br/pay/boleto/02d65876-59d0-446a-bee7-7195fb852ce0",
"txid": "CB001000191120000004473705082450101",
"qrCode": "iVBORw0KGgoAAAANSUhEUgAAA+gAAAPoAQAAAABl2OlJAAAG0ElEQVR4Xu3PAW4dNxCD4dwg979lb9BCIBhSs/tsx15HLfoTsK2VZuYb//j7ZH7Miz8a9FNBPxX0U0E/FfRTQT8V9FNBPxX0U0E/FfRTQT8V9FNBPxX0U0E/FfRTQT8V9FNBPxX0U0E/FfRTQT8V9JW/fnR+1q3Oevf5568XnfWjL2f2OqlAf10xJ6Cjo6Ojozuz17nXu8/TM1tfudvnuC9Vve+c7aDPW3R0dHR09Od116uif3dXdph986tn7LMVdNeho6Oj+92V6Ojfo09D6XufIvnbm6QSHR19BV296HM2Ovqf05PMV1XXpr73vO5+Pxv9rQp0dHR0dPRn9D73lHnb9V3R932+u1tBn7fo6Oj7bdejJ3POq7sV9Hn7/9M7y3nyZ5+Njo4+K64TvvKzz0ZHR58V1wlf+dln/9v0a9KXet17u/5KnV7uOmfQ74N+nYGOjo6O/jld1erwOYYq+txxXd/2fjr7J0FXTffNCapA36u7Dn2/Q0dHT9AV9fZr7vbpPucuFRadKfYXuu89+XqHjo6Ofq1AR++XTLzXV9bb7Ey9X3ubvPvLva73XW+noCfoDjp6v6Kjo+v187orPDc96XXVXV1utUVP1Zu/46P7/m4qOjr6fV1u0Xuq3vyNvoKue02z59n9ErX3mHW7nD1T76CvoKOjz6k9C93T0NE/p6+suvvp7lLFfMl737jKPZngoDvo6FcjFfMF3TPQHXR0T3BaT1V6Hc/Ypblvb5o983e30R109Bl0dPTuQf+arvSMXdxnvdphbqFTzugKegcdHR0d/bv0VLs+vruzU2qcXco+9q47oyvoOfcUd6Gjoyfo6L+vr+wbtJu5r85W3Knu9vPqoDvoPqNP5dUZPZ3o6Oh5daJnYubd/1a1KyMpfc6rt9s3QV9BR8+Uu9+qRkdHV9D76+N6erJJezn5e/ZNT5V9TtB1v09BR9c7Ojr6XR/6FD+md0028DY59cxs6N65masiKOgr6Ojo6Ojo36cr7u3+KHenvPeM9OZ7f11BT9DR9Y0+TXR09H1Gej+qr2rNUte91xv2dO/h3t5Mk697oivo6Ojo6Oh9+6zuep93OVJuu67384R9Wv9V0J1Zj46Ojo6O/pRuxek6v79X5/uoM+gKuvLWVL+/V4eO3t8JuoKuvDXV7+/V/Tf1zLSh8/q7fq/bzNZt6mZXz8yLZsRH1yv6nIOOjo6O/h26z62431rqrnv5nJ79v3DQV9A9AR0dHR3d05/Vr397h8zwveqidd30PA9dQV9Bn3/R0dHRn9adTHPS7bec8r7vm8x56Ap6Z1ajo6Ojz3f0z+qp8ow9S4yz3+Qlejb15tdadN3GQd+D3rX3E9HRVYV+V4u+3/Zs/fSU1MqxZqMr+0ZpG33eo6Ojo6OnFv0ZXbF4d5OtOlHuunqL3l9BT17PQUdHR0d/1YX+vr5m6sVKzlFa0yat9BSn6+Yb+gq6T+jo6Ojo36Fnhr872alt//abKnctvl8ddN+i57uDjo6Ojv5VXdFbSzq1lspZZ2V3Xe+KBD1Bn1PR0dHRZx3653T16Sed+bu7uWv5KvQGPWUFXUFHR0dHR++6J3VVaXK8q7lPu07P15yj3dAV9BV0dHR09O/Wr5or3ZX3eXNn5v/JDrqNj66g309BR7/eoN/1oaO/pWuiK33aX/cN2tCpt8+Nd3B/gq5KdHT0BB0d/Vl9JWr65tTY+8Rscd3surOC7qCjo6Ojuwb9WX16U+2Z+btv0Ps7mtm1Cbqq0NHR0bti/kVH190UPqZ3Xadv059vT72aurvulzp0BR39/hYdHR3d0t5l1X/f0vdJnrXvsr56Wrbxe3brn/0lQV9BR0fXLbpr0NGf1FPR570rWnb1lv2ic+ykDfS7F3R0dPQ20NG/rq9Y2Xtam4qd1KVir3PQV9ATdPT9Hj396PpCd10qfldPMsezp5Fb//jNX7Ou/66g3wUdffbNqejo6Oizrv+uRLem9ESd+s5T95fMyfy5XdvoCrozO9DR0dHRn9Bzv6u74/muT4VV/x+tZmbvhp7XPqOjo6Ojoz+pXy1PardrXX/9bTd1rk7QV9D1jo7eXejo6K6//v6q3v15U2Wn1b3a8aTZi+57dHT0OQ8dPZ3oT+t5072r/NInO/7Knvkfeo8V9BV0dHR0vaGjf5feZ3/7nA1SpWnJPiH/0bx30Oc9Ojo6Onqq0J/RO9Z7SqQ2931cl81zP6vRFfTMREdHR/drKhP0z+gngn4q6KeCfirop4J+Kuingn4q6KeCfirop4J+Kuingn4q6KeCfirop4J+Kuingn4q6KeCfirop4J+Kuingn4q/wAZLZy9TKpLMQAAAABJRU5ErkJggg==",
"copyAndPast": "00020101021226970014BR.GOV.BCB.PIX2575spi-h.bancosemear.com.br/qrcode/gi/v2/cobv/4b22d949129d4fcbbb72092b48c5d7db5204000053039865802BR5923SILVIO DESENVOLVEDOR LT6006PALMAS61081234567862070503***630416B0",
"titleSituationPix": "2",
"fineCod": 0,
"fine": 0.00,
"interestCod": 3,
"interest": 0.00,
"discountCod": 0,
"discount1": 0.00,
"discount2": 0.00,
"discount3": 0.00
}Response #
| Propriedade | Descrição | Tipo |
|---|---|---|
| correlationId | Id interno Semear | String |
| assignorDocument | CNPJ do cedente | String |
| assignorName | Nome do cedente | String |
| creationDate | Data de criação do bolepix | DateTime |
| ourNumber | Número do nosso bolepix | String |
| yourNumber | Seu número (Número informado na request) | String |
| payerName | Nome do pagador | String |
| payerDocument | Documento do pagador | String |
| payerPhone | Telefone do pagador | String |
| payerEmail | Email do pagador | String |
| payerAddress.publicPlace | Rua do pagador | String |
| payerAddress.number | Numero da residencia do pagador | String |
| payerAddress.complement | Complemento do endereco do pagador | String |
| payerAddress.neighborhood | Bairro do pagador | String |
| payerAddress.city | Cidade do pagador | String |
| payerAddress.state | Estado do pagador | String |
| payerAddress.zipCode | CEP do pagador | String |
| value | Valor do bolepix | decimal |
| operationDate | Data de operacao do bolepix | DateTime |
| dueDate | Data de vencimento do bolepix | DateTime |
| digitableLine | Linha digitável do bolepix | String |
| barCode | Código de barras do bolepix | String |
| description | Descrição | String |
| status | Status do bolepix | String |
| type | Tipo do bolepix | String |
| URL de download do bolepix | String | |
| paymentLink | Link de pagamento | String |
| Link para baixar pdf | String | |
| txid | Identificador gerado ao cadastrar novo bolepix. | String |
| qrCode | QrCode gerado quando PIX foi cadastrado com sucesso no bolepix. | String |
| copyAndPast | Copia e cola gerado ao cadastrar novo pix via bolepix. | String |
| titleSituationPix | Codigo referente ao estado do pix gerado(1 = em processamento, 2 = sucesso, 3 = falha) | String |
| fineCod | Código de multa do título | int32 |
| fineDate | Data da multa aplicada ao título | DateTime |
| fine | Valor/taxa de multa do título | decimal |
| interestCod | Código de mora/juros do título | int32 |
| interestDate | Data da mora/juros do título | DateTime |
| interest | Valor/taxa de mora/juros aplicado ao título | decimal |
| discountCod | Código de desconto do título | int32 |
| discountDate1 | Data do Primeiro desconto aplicado ao título | DateTime |
| discount1 | Valor/taxa do primeiro desconto aplicado ao título | decimal |
| discountDate2 | Data do segundo desconto aplicado ao título | DateTime |
| discount2 | Valor/taxa do segundo desconto aplicado ao título | decimal |
| discountDate3 | Data do terceiro desconto aplicado ao título | DateTime |
| discount3 | Valor/taxa do terceiro desconto aplicado ao título | decimal |
