Listar Bolepix

Sumário

Este método é usado para buscar bolepix gerados.

Seguem as URLs e ambientes disponíveis:

  • Produção: https://api2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account={{accountNumber}}
  • Homologação: https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account={{accountNumber}}

Request #

Exemplo de busca dos boletos pelo número da conta

curl --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account=0011223344' \
--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 --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?yourNumber=RafaQA6792242&page=1&itensPage=1000&account=0011223344' \
--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 --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account=0011223344&initialCreationDate=2025-03-12&finalCreationDate=2025-05-12' \
--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 --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?initialDueDate=2025-03-12&finalDueDate=2025-05-12&page=1&itensPage=1000&account=0011223344' \
--header 'client_id: 999abf99-999f-9999-b9ff-9a9999ce9a99' \
--header 'access_token: 9c9999d9-d99c-999f-9999-b9fd9a99bf99'

Exemplo de busca dos boletos pela data de pagamento

curl --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account=0011223344&initialPaymentDate=2025-03-12&finalPaymentDate=2025-05-12' \
--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 --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets?page=1&itensPage=1000&account=0011223344&statusFilter=3' \
--header 'client_id: 95453eaa-bfb5-40b4-bfca-a2aa6c50c704' \
--header 'access_token: c4e42df8-015c-49f7-b44b-3adfa08f3e1c'

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

PropriedadeDescriçãoTipoObrigatoriedade
accountNúmero da containt32Obrigatório
pageNúmero da página do response (Default: 1)int32Obrigatório
itensPageNúmero de elementos no response (Default: 1000)int32Obrigatório
yourNumberSeu número. Informado na geração do boletoint32Opcional
initialCreationDateRetorna todos os boletos criados a partir da data. Formato: YYYY-MM-DD DateTimeOpcional
finalCreationDateRetorna todos os boletos criados até a data. Formato: YYYY-MM-DD DateTimeOpcional
initialDueDateRetorna todos os boletos vencidos a partir da data. Formato: YYYY-MM-DD DateTimeOpcional
finalDueDateRetorna todos os boletos vencidos até a data. Formato: YYYY-MM-DD DateTimeOpcional
statusFilterConsulta os boletos pelo status. Formato: inteiro (0 – Todos / 1 – Em aberto / 2 – Em cartório / 3 – Pago / 5 – Baixado / 6 – Protestado / 7 – Vencido) int32Opcional
initialPaymentDateRetorna todos os boletos pagos a partir da data. Formato: YYYY-MM-DDint32Opcional
finalPaymentDateRetorna todos os boletos pagos até a data. Formato: YYYY-MM-DDint32Opcional

Response #

	{
    "parametros": {
        "paginacao": {
            "paginaAtual": 1,
            "itensPorPagina": 2,
            "quantidadeDePaginas": 14,
            "quantidadeTotalDeItens": 28
        }
    },
    "cobranca": [
        {
            "correlationId": "2222ddd-3333-5555-a0e2-xxxxxiiiiaaaa",
            "assignorDocument": "54444444000111",
            "assignorName": "QAvangers ",
            "payerName": "Nome Bolepix",
            "payerDocument": "85024444444",
            "payerPhone": "31999999999",
            "payerEmail": "a@com.br",
            "payerAddress": {
                "publicPlace": "Rua teste",
                "number": "12345",
                "complement": "Perto da rua teste",
                "neighborhood": "Bairro Teste",
                "city": "Cidade um",
                "state": "MG",
                "zipCode": "12345678"
            },
            "creationDate": "2025-05-07T10:17:31",
            "ourNumber": "10000033333",
            "yourNumber": "6792242",
            "value": 44.17,
            "liquidValue": 43.73,
            "dueDate": "2025-05-10T00:00:00",
            "operationDate": "2025-05-07T10:19:17",
            "accountNumber": 110378590,
            "digitableLine": "74390001134400000461200000384594110770000004417",
            "barcode": "74391107700000044170001144000004610000038459",
            "description": "QA bolepix",
            "status": "Pago",
            "pdf": "https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/2222ddd-3333-5555-a0e2-xxxxxiiiiaaaa/account/110378590/downloads",
            "paymentLink": "https://hml-semearone.bcosemear.net.br/pay/boleto/2222ddd-3333-5555-a0e2-xxxxxiiiiaaaa",
            "txid": "xBpOuM84LnOY5Q2xxxxxxxmpzMJaUF",
            "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAW0AAAFtAQAAAADkegaPAAAFfElEQVR4nO1bMa6jUAw0SkHJEbhJuBgSSFwsuQlHSEmB4vXMvAfRX23xq5VRKKIEhkj4+dmesTH/zbHZF/6Ff+H/Df4ys+Y1rf6Mj83sFmfjaP012jb4srbvbseZKT98cn/6bv6wabUhfraPbrat8bmPc7jnNfbEpYeP1j598e0eRmmfONvg7mIynht7GO8i8LnnqsdHuMOjW8IdOji43fBzvxCc9ghTENQ+zHq7xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxqmUEBt+ECcKdYjKMjdZ/WwhNwcNSfjVmv/p4YDup+zHHRCShVqCOAArNMiVwAjgCGgQmRgIdkciu8aNBEptnnRFdeOA7YAyAOUVC+4FscbG6xu3NWHInh5ZUUsaGiukkwn9QHqHOnnh8+HZXx0cLT2B4mpTEk09RuZXo431WBq+uVsrHX/Dtrj7dNa41xV4GPZSoa8+Ac+2mf5dUGShrrdkU4VTfMxHccmOB8zHLOv6eGy99xTGt5xYrzwq/yipVm2e5XgJcITQfXILHKSvk73jUzDTylh//i+MK/8C/8f8H/AA5261z6KbFAAAAAAElFTkSuQmCC",
            "copyAndPast": "00020101021226970014BR.GOV.BCB.PIX2575spi-h.bancosemear.com.br/qrcode/gi/v2/cobv/13a37f3dc23234320658774283307bd8ec352342342342342342345802BR5914QAVENGERS LTDA6007TIMOTEO62070503***630463AF",
            "titleSituationPix": "2",
            "fineCod": 1,
            "fineDate": "2025-05-11T00:00:00",
            "fine": 10.10,
            "interestCod": 2,
            "interestDate": "2025-05-12T00:00:00",
            "interest": 0.93,
            "discountCod": 2,
            "discountDate1": "2025-05-07T00:00:00",
            "discount1": 1.00,
            "discountDate2": "2025-05-08T00:00:00",
            "discount2": 2.00,
            "discountDate3": "2025-05-09T00:00:00",
            "discount3": 3.00
        },
        {
            "correlationId": "2222ddd-3333-5555-a0e2-zzzzzzzzzzaaaww",
            "assignorDocument": "54444444000111",
            "assignorName": "QAvangers ",
            "payerName": "Nome Bolepix",
            "payerDocument": "85024444444",
            "payerPhone": "31999999999",
            "payerEmail": "a@com.br",
            "payerAddress": {
                "publicPlace": "Rua teste",
                "number": "12345",
                "complement": "Perto da rua teste",
                "neighborhood": "Bairro Teste",
                "city": "Cidade um",
                "state": "MG",
                "zipCode": "12345678"
            },
            "creationDate": "2025-05-06T18:04:50",
            "ourNumber": "10000038333",
            "yourNumber": "RafaQA3644234",
            "value": 33.22,
            "liquidValue": 0.00,
            "dueDate": "2025-05-09T00:00:00",
            "accountNumber": 110378590,
            "digitableLine": "74390001134400000461200000382853110760000003322",
            "barcode": "74391107600000033220001144000004610000038285",
            "description": "QA bolepix",
            "status": "Pago",
            "pdf": "https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/2222ddd-3333-5555-a0e2-zzzzzzzzzzaaaww/account/0110378590/downloads",
            "paymentLink": "https://hml-semearone.bcosemear.net.br/pay/boleto/2222ddd-3333-5555-a0e2-zzzzzzzzzzaaaww",
            "txid": "tE9bJN0ofwHxxxphsnWkGrJgDlBA",
            "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAW0AAAFtAQAAAADkegaPAAAFeklEQVR4nO1bO66rShBs5IDQS2An9saQQPLG8E5YgkMCRL+uqhngnKsX3OiqkQmQDYUl99R09Q/zvzkW+8K/8C/8n8E/ZtZ8htk3G+bl+bnF1Tha//S2PN1ne9xXXBnywwf3t6/mU8Db6e4ep9GWxscurhkgfUdcenhv7dtfvjzs5vaAARo8XUx2m9t3wGG8i8DHjqsOA8w+xaovdgfB4yfw9UJwfG4+1gW3QQLvvvvvvvvvvvvvvvvvvvvvvvvvvvvv/oyw5Ku5+/eQOTG8ejHsYxX+uf5tKZ3Lbt3y2+llhGMbozUnMSrhMWtPYydBZq9rOgyZGa4uc5neYnOLYhTXYA92Z+00kpgWLm0anCkCp4DEdw08ke+l4ZUfjlkYOGwvszCdEl0WkGmjOi6THx5be0JcNck8YRc27jYONxVBno8me2J4fGZOwHS+TBF8mBhAkDk1UVUqPZwuatTURBlUYyKEgQl+gl6dU8S0cGqT6qarJn6U9JTa8VrzhLOUJYXzvuZJ6/7ejoKM9TUFvAJcSUCtPTnFl+WaVe06DcFfAe6rBvOoSKWvRd+Fg2N7bMx65XtieHl3o0RY1TlDkch3jhec5/QSw5HfTehHSqWou1x13EeExbDj8GKZ4TjYdDYqcBzMcRs5MFPP7hygpIXXN5DsqTqx2d6TVR9Aw3pHTz4xfCgvL6C22Nb5d4QdJf1RT3a7Ary8q8LJQ4qR3lUxDsRYZYddBt7X+VnNv68qGytuxqsNy4XgXYWDDjAK3bRhNAZtnyOTzwwX39l0hlFedNOdEt1GdxmUXAAuD63AwooX4+wP+W6KR/Z2bGb4Xxxf+Bf+hf8r+H94VGRRxlDWsgAAAABJRU5ErkJggg==",
            "copyAndPast": "00020101021226970014BR.GOV.BCB.PIX2575spi-h.bancosemear.com.br/qrcode/gi/v2/cobv/9a68cvvvvv5d44860b388f83ffc2902f35204666667779865802BR5914QAVENGERS LTDA6007TIMOTEO62070503***63045B0E",
            "titleSituationPix": "2",
            "fineCod": 1,
            "fineDate": "2025-05-10T00:00:00",
            "fine": 1.01,
            "interestCod": 2,
            "interestDate": "2025-05-11T00:00:00",
            "interest": 0.93,
            "discountCod": 2,
            "discountDate1": "2025-05-06T00:00:00",
            "discount1": 1.00,
            "discountDate2": "2025-05-07T00:00:00",
            "discount2": 2.00,
            "discountDate3": "2025-05-08T00:00:00",
            "discount3": 3.00
        }
    ]
}

Estrutura do body (Response) #

PropriedadeDescriçãoTipo
parametros.paginacao.paginaAtual
parametros.paginacao.itensPorPagina
parametros.paginacao.quantidadeDePaginas
parametros.paginacao.quantidadeTotalDeItens
cobranca.correlationId
cobranca.assignorDocumentCNPJ do cedente String
cobranca.assignorNameNome do cedenteString
cobranca.payerNameNome do pagadorString
cobranca.payerDocumentDocumento do pagadorString
cobranca.payerPhoneTelefone do pagadorString
cobranca.payerEmailEmail do pagadorString
cobranca.payerAddress.publicPlaceRua do pagadorString
cobranca.payerAddress.numberNumero da residencia do pagadorString
cobranca.payerAddress.complementComplemento do endereco do pagadorString
cobranca.payerAddress.neighborhoodBairro do pagadorString
cobranca.payerAddress.cityCidade do pagadorString
cobranca.payerAddress.stateEstado do pagadorString
cobranca.payerAddress.zipcodeCEP do pagadorString
cobranca.creationDateData de criação do bolepixDateTime
cobranca.ourNumberNúmero do nosso bolepixString
cobranca.yourNumberSeu número (Número informado na request)String
cobranca.valueValor do bolepixdecimal
cobranca.liquidValueValor liquido pago do bolepixdecimal
cobranca.dueDateData de vencimento do bolepixDateTime
cobranca.accountNumberNúmero da conta do cedenteString
cobranca.digitableLineLinha digitável do bolepixString
cobranca.barcodeCódigo de barras do bolepixString
cobranca.descriptionDescriçãoString
cobranca.statusStatus do bolepixString
cobranca.pdfURL de download do bolepixString
cobranca.paymentLinkLink de pagamentoString
cobranca.txidIdentificador gerado ao cadastrar novo bolepixString
cobranca.qrCodeQrCode gerado quando PIX foi cadastrado com sucesso no bolepixString
cobranca.copyAndPastCopia e cola gerado ao cadastrar novo pix via bolepixString
cobranca.titleSituationPixCodigo referente ao estado do pix gerado(1 = em processamento, 2 = sucesso, 3 = falha)String
cobranca.fineCodCódigo de multa do títuloint32
cobranca.fineDateData da multa aplicada ao títuloDateTime
cobranca.fineValor/taxa de multa do títulodecimal
cobranca.interestCodCódigo de mora/juros do títuloint32
cobranca.interestDateData da mora/juros do títuloDateTime
cobranca.interestValor/taxa de mora/juros aplicado ao títulodecimal
cobranca.discountCodCódigo de desconto do títuloint32
cobranca.discountDate1Data do primeiro desconto aplicado ao títuloDateTime
cobranca.discount1Valor/taxa do primeiro desconto aplicado ao títulodecimal
cobranca.discountDate2Data do segundo desconto aplicado ao títuloDateTime
cobranca.discount2Valor/taxa do segundo desconto aplicado ao títulodecimal
cobranca.discountDate3Data do terceiro desconto aplicado ao títuloDateTime
cobranca.discount3Valor/taxa do terceiro desconto aplicado ao títulodecimal
What are your Feelings

Distribuído porBetterDocs

Scroll to Top