Criar BolePix

Sumário

Este método é usado para gerar bolepix para pagamento.

Seguem as URLs e ambientes disponíveis:

  • Produção: https://api2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets
  • Homologação: https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets

Request #

curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/public/paas-billets' \
    --location \
    --request POST \
    --header 'accept: */*' \
    --header 'Content-Type: application/json' \
    --header 'client_id: aaaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee' \
    --header 'access_token: 00000000-1111-2222-3333-444444444444' \
    --data-raw '{
        "data": {
        "type": "partners",
        "id": "0",
        "attributes": {
            "assignorAccount": 10085778,
            "assignorDocument": "02147123000152",
            "value": 51.50,
            "dueDate": "2023-12-29",
            "description": "Teste em hml",
            "yourNumber": "321456995",
            "fineCod": 1, 
            "fine": 50.00, 
            "fineDate": "2023-12-30",
            "interestCod": 2, 
            "interest": 35.00, 
            "interestDate": "2023-12-30", 
            "discountCod": 2,
            "discount1": 20.00,
            "discountDate1": "2023-12-27",
            "discount2": 15.00,
            "discountDate2": "2023-12-28",
            "discount3": 30.00,
            "discountDate3": "2023-12-29",
            "payer": {
            "type": 1,
            "document": "94934695060",
            "name": "Nome Teste",
            "email": "teste@pagdividido.com.br",
            "phoneNumber": "11952857414",
            "address": {
                "publicPlace": "Rua Teste",
                "number": "500",
                "complement": "",
                "neighborhood": "Bairro Teste",
                "city": "Sao Paulo",
                "state": "SP",
                "zipCode": "02585700"
            }
            }
        }
      }
    }'

Estrutura do body (Request) #

PropriedadeDescriçãoTipoObrigatoriedade
data.typeTipo (Usar sempre o valor “partners”) String Obrigatorio
data.ididentificador (Usar sempre o valor “0”) String Obrigatorio
data.attributes.assignorAccountNúmero da conta do cedente long Obrigatorio
data.attributes.assignorDocumentDocumento do cedenteStringOpcional
data.attributes.valueValor do boleto (Separado por ponto) DecimalObrigatorio
data.attributes.dueDate Data de vencimento (Usar o formato YYYY-MM-DD) DateTime Obrigatorio
data.attributes.descriptionDescrição do boleto String Obrigatório
data.attributes.yourNumberSeu número (Para controle do cedente) String Obrigatorio
data.attributes.fineCodCódigo de Multa do título, variando de 0 a 2 (0 = Não tem multa, 1 = Valor fixo e 2 = Percentual) int32 Opcional
data.attributes.fineTaxa percentual ou valor fixo de multa do título. Obrigatória se for informado código de multa 1 ou 2. decimal Opcional
data.attributes.fineDateData do vencimento da multa. Obrigatória se for informado código de multa 1 ou 2.
Deve ser maior que a data de vencimento do título e marca a data de início de cobrança de multa(incluindo essa data).
formato: YYYY-MM-DD		DateTimeOpcional
data.attibutes.interestCodCódigo de mora/juros do título, variando de 1 a 3. (1 = valor ao dia, 2 = taxa mensal, 3 = isento)int32Opcional
data.attibutes.interestTaxa percentual ou valor fixo de mora/juros do título. Obrigatória se for informado código de multa 1 ou 2.decimalOpcional
data.attibutes.interestDateData da mora/juros do título. Obrigatória se for informado código de mora 1 ou 2.
Deve ser maior que a data de vencimento do título e marca a data de início de cobrança de mora(incluindo essa data).
formato: YYYY-MM-DD		DateTimeOpcional
data.attributes.discountCodCódigo de desconto do titulo, variando de 0 a 6.
(0 = Não tem desconto, 1 = Valor fixo ate a data informada, 2 = Percetual ate a data informada, 3 = Valor por antecipacao dia corrido, 4 = Valor por antecipacao dia util, 5 = Percentual sobre o valor nominal dia corrido, 6 = Percentual sobre o valor nominal dia util)		inte32Opcional
data.attributes.discount1Valor ou taxa percentual de desconto do titulo. Obrigatório para códigos de desconto de 1 a 6.
Obs: Caso informar descontos, esse deve ser o primeiro a ser preenchido majoritariamente.		decimalOpcional
data.attributes.discountDate1Data de desconto referente a essa entrada de desconto. Obrigatório para discountCod 1 e 2.
Não informar nos demais.		DateTimeOpcional
data.attributes.discount2Valor ou taxa percentual de desconto do titulo. Obrigatório para códigos de desconto de 1 a 6.
Obs: Caso informar descontos, esse deve ser o segundo a ser preenchido.		DateTimeOpcional
data.attributes.discountDate2Data de desconto referente a essa entrada de desconto. Obrigatório para discountCod 1 e 2.
Não informar nos demais e deve ser diferente da data do desconto 1.		DateTimeOpcional
data.attributes.discount3Valor ou taxa percentual de desconto do titulo. Obrigatório para códigos de desconto de 1 a 6.
Obs: Caso informar descontos, esse deve ser o terceiro a ser preenchido.		DateTimeOpcional
data.attributes.discountDate3Data de desconto referente a essa entrada de desconto. Obrigatório para discountCod 1 e 2.
Não informar nos demais e deve ser diferente da data do desconto 2.		DateTimeOpcional
data.attributes.payer.typeTipo do pagador (1: Pessoa física, 2: Pessoa jurídica)int32Obrigatorio
data.attributes.payer.documentNúmero do documento do pagadorStringOpcional
data.attributes.payer.nameNome do pagadorStringOpcional
data.attributes.payer.emailEmail do pagadorStringOpcional
data.attributes.payer.phoneNumberTelefone do pagador (Com o DDD sem o zero. Usar o formato DDNNNNNNNNN)StringOpcional
data.attributes.payer.address.publicPlaceRua do pagadorStringOpcional
data.attributes.payer.address.numberNúmero do pagadorStringOpcional
data.attributes.payer.address.complementComplemento do endereço do pagador (Não obrigatório)StringOpcional
data.attributes.payer.address.neighborhoodBairro do pagadorStringOpcional
data.attributes.payer.address.cityCidade do pagadorStringOpcional
data.attributes.payer.address.stateEstado do pagador (Cógido da cidade, 2 caracteres)StringOpcional
data.attributes.payer.address.zipCodeCEP do pagador (Apenas números)StringOpcional

Response #

{
    "data": {
        "type": "partners",
        "id": 2586,
        "attributes": {
            "id": 8174,
            "cnpj": "221644343136",
            "assignorName": "EMPRESAXYZ",
            "creationDate": "2023-12-26",
            "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-12-28T00: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": "2023-12-30T00:00:00",
            "fine": 50.00,
            "interestCod": 2,
            "interestDate": "2023-12-30T00:00:00",
            "interest": 35.00,
            "discountCod": 2,
            "discountDate1": "2023-12-27T00:00:00",
            "discount1": 20.00,
            "discountDate2": "2023-12-28T00:00:00",
            "discount2": 15.00,
            "discountDate3": "2023-12-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