v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Boleto issue

GenerateRecurrenceBoletoIn

post/GenerateRecurrenceBoletoIn

Request body

methodstring nullable
partnerIdinteger required
businessUnitIdinteger required
tagsstring[] nullable

Example request

{
  "method": "GenerateRecurrenceBoletoIn",
  "partnerId": 1234,
  "businessUnitId": 1234,
  "payee": {
    "name": "Beneficiário",
    "bank": "450",
    "bankBranch": "0001",
    "bankAccount": "00001234",
    "bankAccountDigit": "5",
    "taxNumber": "12345678910"
  },
  "receivers": [
    {
      "splitPercent": 100,
      "name": "Recebedor",
      "bank": "450",
      "bankBranch": "0001",
      "bankAccount": "00001234",
      "bankAccountDigit": "1",
      "taxNumber": "12345678910"
    }
  ],
  "payer": {
    "name": "Pagador",
    "contact": {
      "mail": "email@example.com",
      "phone": "00900000000"
    },
    "address": {
      "city": "São Paulo",
      "state": "SP",
      "zipCode": "00000000",
      "address": "Av. Teste, 000"
    },
    "taxNumber": "12345678910"
  },
  "boletoInformation": {
    "instruction": "Instruction",
    "date": {
      "daysAfterDueDate": 60
    }
  },
  "notifications": {
    "mailToSend": "email@example.com",
    "phoneToSend": "00900000000"
  },
  "additionalInformation": [
    {
      "name": "Produto01"
    }
  ]
}

Response

Ok

Successstring
Messagestring