v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Payments

Generate Payments

Generate Payments.

post/GeneratePayments

Request body

Methodstring required
PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

Example request

{
  "Method": "GeneratePayments",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "JsonOperationBoletoOuts": {
    "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"
    }
  },
  "JsonOperationDARFs": {
    "Method": "GeneratePaymentDARF",
    "PartnerId": 4548,
    "BusinessUnitId": 4548,
    "TaxNumber": "33.762.255/0001-40",
    "FromBank": "001",
    "FromBankBranch": "0801",
    "FromBankAccount": "0178945",
    "FromBankAccountDIgit": "5",
    "GrossRevenuePercentage": "0.0",
    "CalculationPeriod": "2022/06/05",
    "CodeRevenue": "4321",
    "ContributorTaxNumber": "87649862097",
    "ReferenceNumber": "012018",
    "DueDate": "2022-10-24",
    "PrincipalValue": 5,
    "InterestValue": 1,
    "Tags": [
      "my payment order 00051",
      "test 00051"
    ],
    "Description": "This is a new internal transfer",
    "Identifier": "PurchaseTest1106new4",
    "RateValueType": 1
  },
  "JsonOperationGPSs": {
    "Method": "GeneratePaymentGPS",
    "PartnerId": 4548,
    "BusinessUnitId": 4548,
    "TaxNumber": "33.762.255/0001-40",
    "ContributorTaxNumber": "87649862097",
    "PrincipalValue": 5,
    "RateValue": 12.5,
    "DueDate": "2022-10-24",
    "Tags": [
      "my payment order 00051",
      "test 00051"
    ],
    "RateValueType": 1,
    "Description": "This is a new internal transfer",
    "Identifier": "PurchaseTest1106new4",
    "PaymentCode": "3213",
    "ReferenceNumber": "012018",
    "JurisdictionDate": "102017",
    "FromBank": "001",
    "FromBankBranch": "0801",
    "FromBankAccount": "0178945",
    "FromBankAccountDigit": "5",
    "ContributorDocumentType": 2
  },
  "JsonOperationGAREs": {
    "Method": "GeneratePaymentGARE",
    "PartnerId": 4548,
    "BusinessUnitId": 4548,
    "TaxNumber": "33.762.255/0001-40",
    "ContributorTaxNumber": "87649862097",
    "ReferenceNumber": "012018",
    "PrincipalValue": 5,
    "InterestValue": 1,
    "TotalValue": 2.95,
    "RateValue": 12.5,
    "DueDate": "2022-10-24",
    "Tags": [
      "my payment order 00051",
      "test 00051"
    ],
    "CodeRevenue": "4321",
    "StateRegistration": "67890",
    "ActiveDebit": "1",
    "QuoteNumberNotification": "213",
    "RateValueType": 1,
    "Description": "This is a new internal transfer",
    "Identifier": "PurchaseTest1106new4",
    "FromBank": "001",
    "FromBankBranch": "0801",
    "FromBankAccount": "0178945",
    "FromBankAccountDigit": "5"
  },
  "JsonOperationFGTSs": {
    "Method": "GeneratePaymentFGTS",
    "PartnerId": 4548,
    "BusinessUnitId": 4548,
    "TaxNumber": "33.762.255/0001-40",
    "ContributorTaxNumber": "87649862097",
    "PrincipalValue": 5,
    "CodeRevenue": "4321",
    "Barcode": "03394894500000087671760680778200262003064000",
    "FgtsIdentifier": "9",
    "Tags": [
      "my payment order 00051",
      "test 00051"
    ],
    "RateValueType": 1,
    "Description": "This is a new internal transfer",
    "Identifier": "PurchaseTest1106new4",
    "FromBank": "001",
    "FromBankBranch": "0801",
    "FromBankAccount": "0178945",
    "FromBankAccountDigit": "5"
  },
  "JsonOperationDARJs": {
    "Method": "GeneratePaymentDARJ",
    "PartnerId": 4548,
    "BusinessUnitId": 4548,
    "TaxNumber": "33.762.255/0001-40",
    "ContributorTaxNumber": "87649862097",
    "ReferenceNumber": "012018",
    "PrincipalValue": 5,
    "InterestValue": 1,
    "MonetaryValue": 22,
    "TotalValue": 2.95,
    "RateValue": 12.5,
    "DueDate": "2022-10-24",
    "Tags": [
      "my payment order 00051",
      "test 00051"
    ],
    "CodeRevenue": "4321",
    "StateRegistration": "67890",
    "OriginDocument": 2,
    "RateValueType": 1,
    "Description": "This is a new internal transfer",
    "Identifier": "PurchaseTest1106new4",
    "FromBank": "001",
    "FromBankBranch": "0801",
    "FromBankAccount": "0178945",
    "FromBankAccountDigit": "5"
  }
}

Response

OK

successstring
Paymentsstring