v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Boleto issue

GenerateBoleto

post/GenerateBoleto

Request body

Methodstring required
MktPlaceIdnumber required
PartnerIdnumber required
BusinessUnitIdnumber required
GroupTemplatestring required
CustomerNamestring required
CustomerTaxNumberstring required
CustomerMailstring required
CustomerPhonestring required
Neighborhoodstring required
Citystring required
Statestring required
ZipCodestring required
AddressLine1string required
AddressLine2string
MailToSendstring required
PhoneToSendstring
SupplierTaxNumberstring required
SupplierFullNamestring required
SupplierTradingNamestring required
SupplierLegalNamestring required
SupplierBankstring
SupplierBankBranchstring
SupplierBankAccountstring
SupplierBankAccountDigitstring
SupplierMailstring
SupplierPhonestring
RateValuenumber required
RateSentboolean
ExternalNumberstring required
OurNumberstring required
Identifierstring required
Commentsstring required
DueDatestring required
TotalValuenumber required
FineDatestring
FinePercentnumber
FineValuenumber
InterestPercentnumber
InterestValuenumber
DiscountDatestring
DiscountValuenumber
DiscountDate2string
DiscountValue2number
DiscountDate3string
DiscountValue3number
RebateValuenumber
Tagsstring[]

Tags

DivergentPaymentTypenumber
MinPaymentValuenumber
MaxPaymentValuenumber
ExpirationDaysnumber
InterestTypenumber
InterestDatestring

Example request

{
  "Method": "GenerateBoleto",
  "MktPlaceId": 166399,
  "PartnerId": 93234,
  "BusinessUnitId": 40380,
  "GroupTemplate": "2",
  "CustomerName": "Jose Amilton",
  "CustomerTaxNumber": "51198768037",
  "CustomerMail": "jose@email.com",
  "CustomerPhone": "8899999999",
  "City": "Crateus",
  "State": "CE",
  "ZipCode": "63700420",
  "AddressLine1": "Rua Gustavo Barroso",
  "AddressLine2": "Centro",
  "MailToSend": "email@empresa.com",
  "PhoneToSend": "8899999999",
  "SupplierTaxNumber": "51198768037",
  "SupplierFullName": "Amilton Olinda",
  "SupplierTradingName": "Amilton Olinda",
  "SupplierLegalName": "Jose Amilton de Olinda",
  "SupplierBank": "450",
  "SupplierBankBranch": "0001",
  "SupplierBankAccount": "217097",
  "SupplierBankAccountDigit": "5",
  "SupplierMail": "jose.olinda@fitbank.com",
  "SupplierPhone": "8899999999",
  "ExternalNumber": "1234567",
  "OurNumber": "123456789",
  "Identifier": "123",
  "Comments": "Boleto",
  "Products": [
    {
      "type": "LOAN",
      "value": 7000,
      "installments": 12
    }
  ],
  "DueDate": "2022/05/30",
  "TotalValue": 40,
  "FineDate": "2022/05/30",
  "FineValue": 2,
  "DiscountDate": "2022/05/10",
  "DiscountValue": 10,
  "DiscountDate2": "2022/05/20",
  "DiscountValue2": 5,
  "DiscountValue3": 3,
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "OperationVars": [
    [
      {
        "Key": "Boleto rates"
      }
    ]
  ],
  "DivergentPaymentType": 3,
  "MinPaymentValue": 10,
  "MaxPaymentValue": 20,
  "ExpirationDays": 1,
  "InterestDate": "2022/05/25"
}

Response

Ok

Successstring
DocumentNumbernumber
EntryIdnumber
Messagestring
Boletostring
Urlstring
AlreadyExistsstring