Important!
How to define automatic debiting of bank slips after due datePOST /v1/charge/one-step
Requires activation of the
Billing API in your applicationRequest
- Example 1 (CPF)
- Example 2 (CNPJ)
- Example 3 (days_to_write_off)
- Example 4 (Juros mensais)
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"banking_billet": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "[email protected]",
"phone_number": "5144916523",
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-15",
"configurations": {
"fine": 200,
"interest": 33
},
"message": "Usando o atributo message, este conteúdo é exibido no campo OBSERVAÇÃO da cobrança emitida via API
e também no campo OBSERVAÇÃO DO VENDEDOR nos e-mails de cobrança enviados ao cliente
É possível utilizar até 4 linhas de conteúdo, com no máximo 100 caracteres por linha
Essa mensagem poderá ser vista nos e-mails relacionados à cobrança, no boleto ou carnê"
}
}
}
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"banking_billet": {
"customer": {
"email": "[email protected]",
"phone_number": "5144916523",
"juridical_person":{
"corporate_name": "Nome da Empresa",
"cnpj": "99794567000144"
},
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-15",
"configurations": {
"fine": 200,
"interest": 33
},
"message": "Essa cobrança pode ser paga pelo código de barras e pelo QR Code"
}
}
}
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"banking_billet": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "[email protected]",
"phone_number": "5144916523",
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-15",
"configurations": {
"days_to_write_off": 40,
"fine": 200,
"interest": 33
},
"message": "Usando o atributo message, este conteúdo é exibido no campo OBSERVAÇÃO da cobrança emitida via API
e também no campo OBSERVAÇÃO DO VENDEDOR nos e-mails de cobrança enviados ao cliente
É possível utilizar até 4 linhas de conteúdo, com no máximo 100 caracteres por linha
Essa mensagem poderá ser vista nos e-mails relacionados à cobrança, no boleto ou carnê"
}
}
}
{
"items": [
{
"name": "Meu Produto",
"value": 5990,
"amount": 1
}
],
"payment": {
"banking_billet": {
"customer": {
"name": "Gorbadoc Oldbuck",
"cpf": "94271564656",
"email": "[email protected]",
"phone_number": "5144916523",
"address": {
"street": "Avenida Juscelino Kubitschek",
"number": "909",
"neighborhood": "Bauxita",
"zipcode": "35400000",
"city": "Ouro Preto",
"complement": "",
"state": "MG"
}
},
"expire_at": "2023-12-15",
"configurations": {
"fine": 200,
"interest" : {
"value": 330,
"type": "monthly"
}
},
"message": "Usando o atributo message, este conteúdo é exibido no campo OBSERVAÇÃO da cobrança emitida via API
e também no campo OBSERVAÇÃO DO VENDEDOR nos e-mails de cobrança enviados ao cliente
É possível utilizar até 4 linhas de conteúdo, com no máximo 100 caracteres por linha
Essa mensagem poderá ser vista nos e-mails relacionados à cobrança, no boleto ou carnê"
}
}
}
Responses
The responses below represent consumption Success.
- 🟢 200 (Bolix)
- 🟢 200 (Billet)
{
"code": 200, // HTTP return code "200" indicating the request was successful
"data": {
"barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // bank slip's line code
"pix":{
"qrcode": "00020101021226990014BR.GOV.BCB.PIX2577qrcodes-pix.gerencianet.com.br/bolix/v2/cobv/0000000000000000000000000000GERENCIANET SA6010OURO PRETO62070503***63047CB1", // BRCode or copy and paste
"qrcode_image": "data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmc vMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA0NSA0NSIgc2hhcGUtcmVuZGVyaW5nPSJjcmlzcEVkZ2VzIj48cGF0aCBmaWxsPSIjZmZmZmZmIiBkPSJNMCAwaDQ1djQ1SD..." // QR Code image
},
"link": "link_https_to_access_bolix", // responsive Bolix link generated
"billet_link":"link_https_to_access_bolix", // generated Bolix link
"pdf": {
"charge": "link_https_to_bolix_pdf" // Bolix PDF link
},
"expire_at": "2023-12-15", // due date of the bank slip in the following format: 2022-12-15 (equivalent to 15/12/2022)
"charge_id": charge_id_number, // ID number referring to the generated transaction
"status": "waiting", // selected payment method, waiting for payment confirmation ("waiting" equals to "waiting")
"total": 5990, // value in cents. For example: 5990 (equivalent to R$ 59.90)
"payment": "banking_billet" // payment method associated with this transaction ("banking_billet" equals to "bank slip")
}
}
{
"code": 200, // HTTP return code "200" indicating the request was successful
"data": {
"barcode": "00000.00000 00000.000000 00000.000000 0 00000000000000", // bank slip's line code
"link": "link_https_to_access_bank_slip", // responsive bank slip link
"billet_link":"link_https_to_access_bank_slip", // bank slip link
"pdf": {
"charge": "link_https_to_charge_pdf" // PDF link
},
"expire_at": "2023-12-15", // due date of the bank slip in the following format: 2022-12-15 (equivalent to 15/12/2022)
"charge_id": charge_id_number, // ID number referring to the generated transaction
"status": "waiting", // selected payment method, waiting for payment confirmation ("waiting" equals to "waiting")
"total": 5990, // value in cents. For example: 5990 (equivalent to R$ 59.90)
"payment": "banking_billet" // payment method associated with this transaction ("banking_billet" equals to "bank slip")
}
}
Information
Payment made as a Juridical person (PJ)