Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Payments

Generate Boleto Out

Method used to generate payments boletos.

post/GenerateBoletoOut

Request body

Methodstring required
PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

Namestring required

Name From Contract

TaxNumberstring required

Legal Identification From Company

BeneficiaryTaxNumberstring

CPF/CNPJ

BeneficiaryNamestring
GuarantorTaxNumberstring
GuarantorNamestring
PayerTaxNumberstring
PayerNamestring
MailToSendstring
PhoneToSendstring
Barcodestring required
PrincipalValuenumber float

Collection Order Value

DiscountValuenumber
ExtraValuenumber
PaymentDatenumber required

Constitution Date

DueDatestring date required

Date of Due (format YYYY-MM-DD)

Tagsstring[]

Tags

Descriptionstring

Description

Identifierstring

Identifier Of The Transaction

RateValuenumber

Rate value

RateValueTypeinteger

Rate type

PaymentSubTypeinteger
FeePayerFullNamestring

Fee payern name

FeePayerTaxNumberstring

CPF/CNPJ

FeePayerMailstring

Fee payer mail

FeePayerBankstring

Fee payer bank

FeePayerBankBranchstring

Fee payer bank branch

FeePayerBankAccountstring

Fee payer bank account

FeePayerBankAccountDigitstring

Fee payer bank account digit

FeePayerTradingNamestring

Fee payer trading name

FeePayerLegalNamestring

Fee payer legal name

FeePayerIdentityDocumentstring
BankBranchstring

Beneficiary's Bank Branch

BankAccountstring

Beneficiary's Account Number (without digit)

BankAccountDigitstring

Beneficiary's Account Digit

Example request

{
  "Method": "GenerateBoletoOut",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "Name": "Contract Name",
  "TaxNumber": "33.762.255/0001-40",
  "BeneficiaryTaxNumber": "59626023821",
  "BeneficiaryName": "João Silva",
  "GuarantorTaxNumber": "81422414043",
  "GuarantorName": "Maria Helena",
  "PayerTaxNumber": "16982097030",
  "PayerName": "João Alves",
  "MailToSend": "henry@fitbank.com.br",
  "PhoneToSend": "8854324232",
  "Barcode": "03394894500000087671760680778200262003064000",
  "PrincipalValue": 5,
  "DueDate": "2022-10-24",
  "Tags": [
    "my payment order 00051",
    "test 00051"
  ],
  "Description": "This is a new internal transfer",
  "Identifier": "PurchaseTest1106new4",
  "RateValue": 12.5,
  "RateValueType": 1,
  "FeePayerFullName": "Maria Isolda Sales",
  "FeePayerTaxNumber": "086.329.321-21",
  "FeePayerMail": "maria@gmail.com",
  "FeePayerBank": "123",
  "FeePayerBankBranch": "001",
  "FeePayerBankAccount": "012345",
  "FeePayerBankAccountDigit": "1",
  "FeePayerTradingName": "Maria Izolda",
  "FeePayerLegalName": "Maria Izolda da Silva",
  "FeePayerIdentityDocument": "19062375308",
  "Entries": {
    "Name": "Adrian",
    "TaxNumber": "59018996017",
    "Value": 100,
    "Description": "Repasse",
    "Bank": "450",
    "BankBranch": "0001",
    "BankAccount": "88252",
    "BankAccountDigit": "5"
  }
}

Response

OK

Successboolean
DocumentNumberinteger
EntryIdinteger
Urlstring
Existsboolean

Example response

{
  "DocumentNumber": 142578,
  "EntryId": 10,
  "Url": "http://www.pdfurl.com.br/pdf?filename=2022-04-04/omu1tvh3.pdf"
}