Listar Bolepix

Sumário

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/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

PropriedadeDescriçãoTipoObrigatoriedade
accountNumberNúmero da conta int32Obrigatório
originTransactionConsulta realizada para o Bolepix (3 – Bolepix)int32Obrigatório
yourNumberSeu número. Informado na geração do boleto int32Opcional
creationDateRetorna todos os boletos criados a partir da data. Formato: YYYY-MM-DD DateTimeOpcional
endCreationDateRetorna todos os boletos criados até a data. Formato: YYYY-MM-DD DateTimeOpcional
dueDateRetorna todos os boletos vencidos a partir da data. Formato: YYYY-MM-DD DateTimeOpcional
endDueDateRetorna todos os boletos vencidos até a data. Formato: YYYY-MM-DD DateTimeOpcional
statusConsulta os boletos pelo status. Formato: inteiro (1 – Em Aberto, 2- Em Cartório, 3 – Pago, 4 – Pago, 5 – Baixado, 6 – Protestado, 7- Vencido) int32Opcional
pageNumberNúmero da página do response (Default: 1)int32Opcional
pageSizeNúmero de elementos no response (Default: 50)int32Opcional

Response #

	{
    "meta": {
        "totalPages": 1,
        "totalRegisters": 37
    },
    "data": [
        {
            "type": "partners",
            "id": 40842,
            "attributes": {
                "id": 119339,
                "cnpj": "2890111100132",
                "assignorName": "PaaS",
                "payerName": "Nome PaaS Bolepix",
                "payerDocument": "85027978081",
                "payerPhone": "",
                "payerEmail": "",
                "payerAddress": {
                    "publicPlace": null,
                    "number": null,
                    "complement": null,
                    "neighborhood": null,
                    "city": null,
                    "state": null,
                    "zipCode": null
                },
                "creationDate": "2024-06-27T16:24:21",
                "ourNumber": "00000040842",
                "yourNumber": "4454612",
                "value": 34.90,
                "liquidValue": 0.00,
                "dueDate": "2024-06-30T00:00:00",
                "operationDate": null,
                "accountNumber": 110379871,
                "digitableLine": "74390001131200000710900000408427197630000003490",
                "barcode": "74391976300000034900001112000007100000040842",
                "description": "PaaS bolepix <br>\nTAXA DE PERMANÊNCIA DE 5.93% AO DIA <br>\nAPÓS 01/07/2024 COBRAR MULTA DE 3.89%<br>\nATUALIZAÇÃO DE BOLETO VENCIDO E 2ª VIA, ACESSE BANCOSEMEAR.COM.BR <br>\nSAC 0800 702 6700 - OUVIDORIA 0800 942 7600 <br>\nPAGAR PREFERENCIALMENTE EM AGENCIAS BANCARIAS OU CASAS LÓTERICAS <br>\nVERIFIQUE OS DADOS DO REMETENTE E DO BENEFICIARIO ANTES DO PAGTO <br>\nEM CASO DE DÚVIDAS, ACIONE OS CANAIS OFICIAIS DO BANCO SEMEAR <br>",
                "status": "Em Aberto",
                "type": 2,
                "pdf": "https://awshmllbgw.bancosemear.com.br/digital-account-billet/api/v1/paas-billets/accounts/110379871/numbers/00000040842/downloads",
                "paymentLink": "https://hml-semearpay.bancosemear.com.br/pay/boleto/2mK0a6bd_cxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxABfFY2t6M9Y_lxJFg==",
                "originTransaction": 0,
                "fineCod": 2,
                "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": 20.00,
                "discountDate2": "2024-06-28T00:00:00",
                "discount2": 15.00,
                "discountDate3": "2024-06-29T00:00:00",
                "discount3": 30.00
            }
        },

Estrutura do body (Response) #

PropriedadeDescriçãoTipo
data.typeTipo String
data.idNúmero do bolepix int32
data.attributes.idId interno SemearString
data.attributes.cnpjCNPJ do cedente String
data.attributes.assignorNameNome do cedenteString
data.attributes.creationDateData de criação do bolepix DateTime
data.attributes.ourNumberNúmero do nosso bolepix String
data.attributes.yourNumberSeu número (Número informado na request) String
data.attributes.payerNameNome do pagadorString
data.attributes.payerDocumentDocumento do pagadorString
data.attributes.payerPhoneTelefone do pagadorString
data.attributes.payerEmailEmail do pagadorString
data.attributes.payerAddress.publicPlaceRua do pagadorString
data.attributes.payerAddress.numberNumero da residencia do pagadorString
data.attributes.payerAddress.complementComplemento do endereco do pagadorString
data.attributes.payerAddress.neighborhoodBairro do pagadorString
data.attributes.payerAddress.cityCidade do pagadorString
data.attributes.payerAddress.stateEstado do pagadorString
data.attributes.payerAddress.zipCodeCEP do pagadorString
data.attributes.valueValor do bolepix decimal
data.attributes.liquidValueValor liquido pago do bolepixdecimal
data.attributes.dueDateData de vencimento do bolepix DateTime
data.attributes.accountNumberNúmero da conta do cedente String
data.attributes.digitableLineLinha digitável do bolepixString
data.attributes.barCodeCódigo de barras do bolepixString
data.attributes.descriptionDescriçãoString
data.attributes.statusStatus do bolepixString
data.attributes.typeTipo do bolepixString
data.attributes.pdfURL de download do bolepixString
data.attributes.paymentLinkLink de pagamentoString
data.attributes.txidIdentificador gerado ao cadastrar novo bolepix.String
data.attributes.qrCodeQrCode gerado quando PIX foi cadastrado com sucesso no bolepix.String
data.attributes.copyAndPastCopia e cola gerado ao cadastrar novo pix via bolepix.String
data.attributes.titleSituationPixCodigo referente ao estado do pix gerado(1 = em processamento, 2 = sucesso, 3 = falha)String
data.attributes.originTransactionDetermina a origem da transação (3 = BOLEPIX)int32
data.attributes.fineCodCódigo de multa do títuloint32
data.attributes.fineDateData da multa aplicada ao títuloDateTime
data.attributes.fineValor/taxa de multa do títulodecimal
data.attributes.interestCodCódigo de mora/juros do títuloint32
data.attributes.interestDateData da mora/juros do títuloDateTime
data.attributes.interestValor/taxa de mora/juros aplicado ao títulodecimal
data.attributes.discountCodCódigo de desconto do títuloint32
data.attributes.discountDate1Data do Primeiro desconto aplicado ao títuloDateTime
data.attributes.discount1Valor/taxa do primeiro desconto aplicado ao títulodecimal
data.attributes.discountDate2Data do segundo desconto aplicado ao títuloDateTime
data.attributes.discount2Valor/taxa do segundo desconto aplicado ao títulodecimal
data.attributes.discountDate3Data do terceiro desconto aplicado ao títuloDateTime
data.attributes.discount3Valor/taxa do terceiro desconto aplicado ao títulodecimal
What are your Feelings

Distribuído porBetterDocs

Scroll to Top