Este método é usado para gerar boletos para pagamento.
Seguem as URLs e ambientes disponíveis:
- Produção: https://api2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets
- Homologação: https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/paas-billets
Request #
curl 'https://hmlapi2.bancosemear.com.br/digital-account-billet/api/v1/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-01-20",
"description": "Teste em hml",
"yourNumber": "321456995",
"fineCod": 1,
"fine": 50.00,
"fineDate": "2023-01-28",
"interestCod": 2,
"interest": 35.00,
"interestDate": "2023-01-28",
"discountCod": 2,
"discount1": 20.00,
"discountDate1": "2023-01-25",
"discount2": 15.00,
"discountDate2": "2023-01-25",
"discount3": 30.00,
"discountDate3": "2023-01-26",
"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) #
Propriedade | Descrição | Tipo | Obrigatoriedade |
---|---|---|---|
data.type | Tipo (Usar sempre o valor “partners”) | String | Obrigatorio |
data.id | identificador (Usar sempre o valor “0”) | String | Obrigatorio |
data.attributes.assignorAccount | Número da conta do cedente | long | Obrigatorio |
data.attributes.assignorDocument | Documento do cedente | String | Opcional |
data.attributes.value | Valor do boleto (Separado por ponto) | Decimal | Obrigatorio |
data.attributes.dueDate | Data de vencimento (Usar o formato YYYY-MM-DD) | DateTime | Obrigatorio |
data.attributes.description | Descrição do boleto | String | Obrigatório |
data.attributes.yourNumber | Seu número (Para controle do cedente) | String | Obrigatorio |
data.attributes.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 |
data.attributes.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 |
data.attributes.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 |
data.attibutes.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 |
data.attibutes.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 |
data.attibutes.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 |
data.attributes.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 |
data.attributes.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 |
data.attributes.discountDate1 | Data de desconto referente a essa entrada de desconto. Obrigatório para discountCod 1 e 2. Não informar nos demais. | DateTime | Opcional |
data.attributes.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 |
data.attributes.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 |
data.attributes.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 |
data.attributes.payer.type | Tipo do pagador (1: Pessoa física, 2: Pessoa jurídica) | int32 | Obrigatorio |
data.attributes.payer.document | Número do documento do pagador | String | Opcional |
data.attributes.payer.name | Nome do pagador | String | Opcional |
data.attributes.payer.email | Email do pagador | String | Opcional |
data.attributes.payer.phorneNumber | Telefone do pagador (Com o DDD sem o zero. Usar o formato DDNNNNNNNNN) | String | Opcional |
data.attributes.payer.address.publicPlace | Rua do pagador | String | Opcional |
data.attributes.payer.address.number | Número do pagador | String | Opcional |
data.attributes.payer.address.complement | Complemento do endereço do pagador (Não obrigatório) | String | Opcional |
data.attributes.payer.address.neighborhood | Bairro do pagador | String | Opcional |
data.attributes.payer.address.city | Cidade do pagador | String | Opcional |
data.attributes.payer.address.state | Estado do pagador (Cógido da cidade, 2 caracteres) | String | Opcional |
data.attributes.payer.address.zipCode | CEP do pagador (Apenas números) | String | Opcional |
Response #
{
"data": {
"type": "partners",
"id": 2586,
"attributes": {
"id": 8174,
"cnpj": "221644343136",
"assignorName": "EMPRESAXYZ",
"creationDate": "2023-07-03T00:00:00-03:00",
"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-07-17T00: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==",
"originTransaction": 0,
"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) #
Propriedade | Descrição | Tipo |
---|---|---|
data.type | Tipo | String |
data.id | Número do boleto | int32 |
data.attributes.id | Id interno Semear | String |
data.attributes.cnpj | CNPJ do cedente | String |
data.attributes.assignorName | Nome do cedente | String |
data.attributes.creationDate | Data de criação do boleto | DateTime |
data.attributes.ourNumber | Número do boleto | String |
data.attributes.yourNumber | Seu número (Número informado na request) | String |
data.attributes.payerName | Nome do pagador | String |
data.attributes.payerDocument | Documento do pagador | String |
data.attributes.payerPhone | Telefone do pagador | String |
data.attributes.payerEmail | Email do pagador | String |
data.attributes.payerAddress.publicPlace | Rua do pagador | String |
data.attributes.payerAddress.number | Numero da residencia do pagador | String |
data.attributes.payerAddress.complement | Complemento do endereco do pagador | String |
data.attributes.payerAddress.neighborhood | Bairro do pagador | String |
data.attributes.payerAddress.city | Cidade do pagador | String |
data.attributes.payerAddress.state | Estado do pagador | String |
data.attributes.payerAddress.zipCode | CEP do pagador | String |
data.attributes.value | Valor do boleto | decimal |
data.attributes.liquidValue | Valor liquido pago do boleto | decimal |
data.attributes.dueDate | Data de vencimento do boleto | DateTime |
data.attributes.accountNumber | Número da conta do cedente | String |
data.attributes.digitableLine | Linha digitável do boleto | String |
data.attributes.barCode | Código de barras do boleto | String |
data.attributes.description | Descrição | String |
data.attributes.status | Status do boleto | String |
data.attributes.type | Tipo do boleto | String |
data.attributes.pdf | URL de download do boleto | String |
data.attributes.paymentLink | Link de pagamento | String |
data.attributes.originTransaction | Determina a origem da transação (0 = BOLETO, 3 = BOLEPIX) | int32 |
data.attributes.fineCod | Código de multa do título | int32 |
data.attributes.fineDate | Data da multa aplicada ao título | DateTime |
data.attributes.fine | Valor/taxa de multa do título | decimal |
data.attributes.interestCod | Código de mora/juros do título | int32 |
data.attributes.interestDate | Data da mora/juros do título | DateTime |
data.attributes.interest | Valor/taxa de mora/juros aplicado ao título | decimal |
data.attributes.discountCod | Código de desconto do título | int32 |
data.attributes.discountDate1 | Data do Primeiro desconto aplicado ao título | DateTime |
data.attributes.discount1 | valor/taxa do Primeiro desconto aplicado ao título | decimal |
data.attributes.discountDate2 | Data do segundo desconto aplicado ao título | DateTime |
data.attributes.discount2 | valor/taxa do segundo desconto aplicado ao título | decimal |
data.attributes.discountDate3 | Data do terceiro desconto aplicado ao título | DateTime |
data.attributes.discount3 | valor/taxa do terceiro desconto aplicado ao título | decimal |