v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Queries

Get DARF Out By Id

Returns a DARF payment by document number.

post/GetDARFOutById

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

DocumentNumberinteger required

Transaction id

Example request

{
  "Method": "GetDarfOutById",
  "PartnerId": 4548,
  "BusinessUnitId": 4548,
  "DocumentNumber": 656
}

Response

Successboolean

DARFstring

Messagestring

Validationobject

Example response

{
  "DARF": "\"DARF\": \"{\"TaxNumber\":\"33109855046\",\"DarfType\":1,\"CalculationPeriod\":\"2022-06-05T00:00:00\",\"ReferenceNumber\":\"12018\",\"DueDate\":\"2022-06-20T00:00:00\",\"GrossRevenueValue\":0.00,\"GrossRevenuePercentage\":\"1.0\",\"PrincipalValue\":168.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-10T00:00:00\",\"CodeRevenue\":\"4321\",\"NumberCompanyInscription\":\"00330120004902588282\",\"PeriodCalculation\":\"2022-06-05T00:00:00\",\"NumberReference\":\"012018\",\"ValueInterestCharges\":17890.00,\"NameContributor\":\"Ana Victoria\",\"ValueRecipeGrossAccumulated\":0.00,\"PercentageRecipeGrossAccumulated\":10.00,\"PaymentAuthentication\":null,\"ReceiptUrl\":\"http://www.pdfurl.com.br/pdf?filename=2022-04-08/g4hj43i4.pdf\",\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"34cc9927160841148be7e39746d919a4\",\"DocumentNumber\":70452,\"CreationDate\":\"0001-01-01T00:00:00\",\"Tags\":null,\"Description\":null}\""
}