v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Payments

Generate Payment DARJ

Method used to generate payments DARJ

post/GeneratePaymentDARJ

Request body

Methodstring required

PartnerIdinteger

Number Of The Partner

BusinessUnitIdinteger

Number Of The BusinessUnit

TaxNumberstring required

Legal Identification From Company

ContributorTaxNumberstring required

ReferenceNumberstring

PrincipalValuenumber float required

Collection Order Value

FineValuenumber float

Fine Value

InterestValuenumber float

Interest Value

MonetaryValuenumber

TotalValuenumber

Value Of The Transaction

RateValuenumber

Rate value

DueDatestring date

Date of Due (format YYYY-MM-DD)

PaymentDatenumber required

Constitution Date

Tagsstring[]

Example request

{
  "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

Successboolean

DocumentNumberinteger

Urlstring

Example response

{
  "DocumentNumber": 30319,
  "Url": "http://www.pdfurl.com.br/pdf?filename=2021-05-25/o4u0hmb0.pdf"
}