Este método é usado para gerar bolepix para pagamento.
Seguem as URLs e ambientes disponíveis:
- Produção: https://api2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets
- Homologação: https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets
Request #
curl 'https://hmlapi2.bancosemear.com.br/paas-billet-api/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 '{
"assignorAccount": "0123456789",
"assignorDocument": "01234567890123",
"value": 34.90,
"dueDate": "2024-09-05",
"description": "123456789012345678901234567890123456789012345678901234567890123456789012345678",
"yourNumber": "123456789012345",
"FINECOD": 1,
"FINE": 50.00,
"FINEDATE": "2024-09-26",
"INTERESTCOD": 2,
"INTEREST": 35.00,
"INTERESTDATE": "2024-09-29",
"DISCOUNTCOD": 2,
"DISCOUNT1": 20.00,
"DISCOUNTDATE1": "2024-08-27",
"DISCOUNT2": 15.00,
"DISCOUNTDATE2": "2024-08-28",
"DISCOUNT3": 30.00,
"DISCOUNTDATE3": "2024-08-29",
"payer": {
"type": 1,
"document": "85027978081",
"name": "Bernhard",
"email": "Nicolas.Lynch@yahoo.com",
"phoneNumber": "21999889999",
"address": {
"publicPlace": "123456789012345678901234567890123456789012345678901234567890123456789012345678",
"NUMBER": "12345",
"COMPLEMENT": "12345678901234567890123456789012345678901234567890",
"NEighborhood": "1234567890123456789012345678901234567890",
"city": "Palmas",
"state": "MG",
"zipCode": "12345678"
}
}
}'Estrutura do body (Request) #
| Propriedade | Descrição | Tipo | Obrigatoriedade |
|---|---|---|---|
| assignorAccount | Número da conta do cedente | long | Obrigatorio |
| assignorDocument | Documento do cedente | String | Opcional |
| value | Valor do boleto (Separado por ponto) | Decimal | Obrigatorio |
| dueDate | Data de vencimento (Usar o formato YYYY-MM-DD) | DateTime | Obrigatorio |
| description | Descrição do boleto | String | Obrigatório |
| yourNumber | Seu número (Para controle do cedente) | String | Obrigatorio |
| fineCod | Código de Multa do título, variando de 0 a 2 (0 = Não tem multa, 1 = Valor fixo e 2 = Percentual) | int32 | Opcional |
| fine | Taxa percentual ou valor fixo de multa do título. Obrigatória se for informado código de multa 1 ou 2. | decimal | Opcional |
| fineDate | Data 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 | DateTime | Opcional |
| interestCod | Código de mora/juros do título, variando de 1 a 3. (1 = valor ao dia, 2 = taxa mensal, 3 = isento) | int32 | Opcional |
| interest | Taxa percentual ou valor fixo de mora/juros do título. Obrigatória se for informado código de multa 1 ou 2. | decimal | Opcional |
| interestDate | Data 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 | DateTime | Opcional |
| discountCod | Có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) | inte32 | Opcional |
| discount1 | Valor 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. | decimal | Opcional |
| discountDate1 | Data de desconto referente a essa entrada de desconto. Obrigatório para discountCod 1 e 2. Não informar nos demais. | DateTime | Opcional |
| discount2 | Valor 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. | DateTime | Opcional |
| discountDate2 | Data 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. | DateTime | Opcional |
| data.attributes.discount3 | Valor 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. | DateTime | Opcional |
| discountDate3 | Data 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. | DateTime | Opcional |
| payer.type | Tipo do pagador (1: Pessoa física, 2: Pessoa jurídica) | int32 | Obrigatorio |
| payer.document | Número do documento do pagador | String | Opcional |
| payer.name | Nome do pagador | String | Opcional |
| payer.email | Email do pagador | String | Opcional |
| payer.phoneNumber | Telefone do pagador (Com o DDD sem o zero. Usar o formato DDNNNNNNNNN) | String | Opcional |
| payer.address.publicPlace | Rua do pagador | String | Opcional |
| payer.address.number | Número do pagador | String | Opcional |
| payer.address.complement | Complemento do endereço do pagador (Não obrigatório) | String | Opcional |
| payer.address.neighborhood | Bairro do pagador | String | Opcional |
| payer.address.city | Cidade do pagador | String | Opcional |
| payer.address.state | Estado do pagador (Cógido da cidade, 2 caracteres) | String | Opcional |
| payer.address.zipCode | CEP do pagador (Apenas números) | String | Opcional |
Response #
{
"correlationId": "8738284d-e9e1-4e12-bbd8-24c09f12cb4a",
"assignorDocument": "01234567890123",
"assignorName": "Silvio LTDA",
"payerName": "Verda",
"payerDocument": "85027978081",
"payerPhone": "21999889999",
"payerEmail": "Boyd95@yahoo.com",
"payerAddress": {
"publicPlace": "123456789012345678901234567890123456789012345678901234567890123456789012345678",
"number": "12345",
"complement": "12345678901234567890123456789012345678901234567890",
"neighborhood": "1234567890123456789012345678901234567890",
"city": "Palmas",
"state": "MG",
"zipCode": "12345678"
},
"creationDate": "2024-08-26T11:42:48",
"ourNumber": "00000045858",
"yourNumber": "123456789012345",
"value": 41.99,
"dueDate": "2024-09-05T00:00:00",
"operationDate": "2024-08-26T11:42:48",
"accountNumber": 123456789,
"digitableLine": "74390001131200000880000000458588398300000004199",
"barcode": "74393983000000041990001112000008800000045858",
"description": "123456789012345678901234567890123456789012345678901234567890123456789012345678",
"status": "Em Aberto",
"pdf": "https://hmlapi2.bancosemear.com.br/paas-billet-api/api/v1/public/paas-billets/8738284d-e9e1-4e12-bbd8-24c09f12cb4a/account/0123456789/downloads",
"paymentLink": "https://hml-semear-front-end.net.br/pay/boleto/8738284d-e9e1-4e12-bbd8-24c09f12cb4a",
"txid": "CB001000191120000004585826082450101",
"qrCode": "iVBORw0KGgoAAAANSUhEUgAAA+gAAAPoAQAAAABl2OlJAAAGsUlEQVR4Xu3PDY4bRwyEUd8g97+lb5BkQFSqyB7Z3tWsaQRfAZL6h81Hfft7M9/mwW8N+lbQt4K+FfStoG8FfSvoW0HfCvpW0LeCvhX0raBvBX0r6FtB3wr6VtC3gr4V9K2gbwV9K+hbQd8K+pXv3zJ//XdWK91fu+//fs9dfWqn+PVd7yvoryrQ8x4dHR0d/R0931V/99XO/eRlelWf0DXoV9DnKTo6Ojq6K57VVV8Vvbt3niZ3drzTq7N3BV116OjoDnpWoqM/rftTJ/rOCt9UB9eU2Xv5pYJeb9HR0aeBjo7+Vbpe607fvdb1uu3T+j06uoJ+X4GuO/RZi47+rp7rc5LudM2ZfV6dXUGfp+jo6Ojo6E/rGTvPfHpvdHT0WXF2eOfTe6Ojo8+Ks8M7n977T9PP1Jt677NaX3e5Uq1r8uRV0O+Dju4zdHSv0NE/o1e1POdOdnfVvD6r+vw46FWT77KLK9BfS3dn6OjoDnrV5Lvs4or/rz571xT5qrp7un5WO3VRppg79DxFR0dHR1c/dUZ/Qle33r3Xe66c0eKcTLPniYN+BR0dHX2+QEd/Tq/Xeqnu2eNVxTzV/5g9tbePXpld0NHR7yvmKfrZU3v0K+iKDXX3bvZW3z6lvvUy53S9gq6go6Ojo6N/jX5qrnTf7JSTZq3fV1XOnNOhV9DR0dF9h46u26f1Wt/3Pnt4Is+ot/4POa0V9Aq61ujo6HmOrl/093R38sdvsod2OW3u+xS1mlNX0Cvo6Ojo6Ohfp1+xUx3Up0+R0yld8jzyVI1eQXfQ0dHR0b9St1Jvcn93e3qq9HTp+1ZB1/nsj/7qFh0dXZXo6L+mV21/5a5lyKnf+abfe+fPnAT9Cjr67I3ufvU73/R779DR0ZXUVeGdDH1nB9W+tlzR1w66ztG9Q0dHR0d/XpfnXl2X0qepk+zTJ3PPrESvoKOjo6Ojf53uLtPRjXqesm90W7/ud95eQdc5Ojo6+jTQ0Z/US3Rn+za07t01h17kZLOzgl6ZNejo6Ojo6M/p6qN1yj71bHOW2btPcvZCd9C1Rp+n6Oh5go6u2l/Xr9qeWd+9WaeafvaqawX9R3XouUKfdarpZ6+6VtB/VIeeK/RZp5p+9qpr5U/R3fVOrZ17Z112rd35sm6qh330Cjo6ep6jo6M/q1f0wp/srL2+7+fS2m/yhYOeQUdHR0dHf17Prtqry93peTJn6p6mRK+gX0G/c+5PzxN0dHT0j+kzfq3bXqd+6u+TOu1Br6CrCn0GHV0n6HmP/lnddepRiqRaZ6VPfGO9d7uvRa+go6OjTwsd/ez4Od0d/ebuRN2005mMXpH3qnHQ6/zOOk/Q0dHR0WcF+s/1K68q06lZHCvZVyc5hadS0BV079DR0dHRn9Szwor2XrlbVaUy5/eJX2TQr6Cjo6Ojo3+dnsrdPmew7Tmzsmv2daugV9DRzz06Ojr6c7r7pZLC/a1m02131V0VDnoF/b4/utbzFt236OjoP9evVOe7s+p6rrp8CjnB7I/uoN+doZ8rdHR0dL/+FT0733XSTe99ds8Xtda052v0K+jo6Ojo6Of7Z3X/1tqpDnmqnprXb1znu7v+6HmKrjMHPU/R0dF1i/5RvfrqxeypLrObNU9Y8WTunPfoWYmOjl636Ojoz+q6rYqqP1+oenbss/bJsit6Bf0KOjo6OvrMV+j25quqUE//9gnUJYX8V/MOXVUVdHR0VaCjoz+lK9knlZpG771X19Oss3M+16Fn0NHR0dGloD+nz075qls5U9X0Hp53vu02egUdHR19dkBHf053hXZ+maZn03eea9XndrqBfneDjo6uGnR09Cf0K+mpizv6JM/S6K/Ot7qroDvo6K5F76/Ra4+ep+jnW91Vpu64Y193QZN6gutWu6p0Xf5eQb8L+rlGR9cdOjr6R3X1VGcb6tQF3aSmuz5rTtf/B/oVdAVdK3R016Kjv6/7PHv5jZycKSeR2ud2nXso6L6da3R0dHT0qkB/X8/OuZ9vfaf681uu61TtoF9Br3t0dHR09N+nq5u6eBIn1dw5mmS+Rdc5Ojo6OnrdzQ7oz+up6rzO8o1WqtHOc+pbPdwB/Qq6K9DR1RndQa+VarRD/4ie65Rqn26daiKldzj7dAX9PJ+v0NEddHT0qcw+6E7qGWl21Um3rnRULSN/60X/B+hX0N0THR0dXbeudNA/o28EfSvoW0HfCvpW0LeCvhX0raBvBX0r6FtB3wr6VtC3gr4V9K2gbwV9K+hbQd8K+lbQt4K+FfStoG8FfSv/AKb13W7iL4zgAAAAAElFTkSuQmCC",
"copyAndPast": "00020101021226970014BR.GOV.BCB.PIX2575spi-h.bancosemear.com.br/qrcode/gi/v2/cobv/3542820de82945e284646b7f041fdeaf5204000053039865802BR5923SILVIO DESENVOLVEDOR LT6006PALMAS61081234567862070503***63047A60",
"titleSituationPix": "2",
"fineCod": 1,
"fineDate": "2024-09-26T00:00:00",
"fine": 50.00,
"interestCod": 2,
"interestDate": "2024-09-29T00:00:00",
"interest": 35.00,
"discountCod": 2,
"discountDate1": "2024-08-27T00:00:00",
"discount1": 20.00,
"discountDate2": "2024-08-28T00:00:00",
"discount2": 15.00,
"discountDate3": "2024-08-29T00:00:00",
"discount3": 30.00
}Estrutura do body (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 |
| 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 |
