v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Boleto issue

GenerateRecurrenceBoleto

post/GenerateRecurrenceBoleto

Request body

Methodstring required
MktPlaceIdnumber required
PartnerIdnumber required
BusinessUnitIdnumber required
GroupTemplatestring required
CustomerNamestring required
CustomerTaxNumberstring required
CustomerMailstring required
CustomerPhonestring required
SupplierTaxNumberstring required
SupplierFullNamestring required
SupplierTradingNamestring required
SupplierLegalNamestring required
SupplierMailstring
SupplierPhonestring
AddressLine1string required
AddressLine2string
Neighborhoodstring required
Citystring required
Statestring required
ZipCodestring required
MailToSendstring required
PhoneToSendstring required
ExternalNumberstring required
Identifierstring required
Commentsstring required
DueDatestring required
TotalValuenumber required
FineValuestring
FinePercentnumber
FineDatestring
InterestValuenumber
InterestPercentnumber
DiscountDatestring
DiscountValuenumber
RebateValuenumber
InstallmentsNumbernumber required
Carnetboolean required

Example request

{
  "Method": "GenerateRecurrenceBoleto",
  "MktPlaceId": 123,
  "PartnerId": 12345,
  "BusinessUnitId": 123456789,
  "GroupTemplate": "2",
  "CustomerName": "Jose Amilton",
  "CustomerTaxNumber": "51198768037",
  "CustomerMail": "jose@email.com",
  "CustomerPhone": "8899999999",
  "SupplierTaxNumber": "51198768037",
  "SupplierFullName": "Amilton Olinda",
  "SupplierTradingName": "Amilton Olinda",
  "SupplierLegalName": "Jose Amilton de Olinda",
  "SupplierMail": "jose.olinda@fitbank.com",
  "SupplierPhone": "8899999999",
  "AddressLine1": "Rua Gustavo Barroso",
  "AddressLine2": "Centro",
  "Neighborhood": "Jardim",
  "City": "Crateus",
  "State": "CE",
  "ZipCode": "63700420",
  "MailToSend": "email@empresa.com",
  "PhoneToSend": "8899999999",
  "ExternalNumber": "12345679101",
  "Identifier": "123",
  "Comments": "Comentario do boleto",
  "Products": [
    {
      "type": "LOAN",
      "value": 7000,
      "installments": 12
    }
  ],
  "DueDate": "2022/05/30",
  "TotalValue": 40,
  "FineDate": "2022/05/30",
  "DiscountDate": "2022/05/10",
  "DiscountValue": 10,
  "InstallmentsNumber": 15,
  "Carnet": true
}

Response

Ok

Successstring
DocumentNumberstring
EntryIdstring
Messagestring
Urlstring
AlreadyExistsstring