v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Queries

Get DARJ Out By Id

Returns a DARJ payment by document number.

post/GetDARJOutById

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

DocumentNumberinteger required

Transaction id

Example request

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

Response

Successboolean

DARJstring

Messagestring

Validationobject

Example response

{
  "DARJ": "{\"TaxNumber\":\"33109855046\",\"OriginDocument\":2,\"CodeRevenue\":\"4321\",\"StateRegistration\":\"67890\",\"NumberReference\":\"12018\",\"PrincipalValue\":190.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"MonetaryValue\":0.00,\"TotalValue\":19310.67,\"DueDate\":\"2022-05-20T00:00:00\",\"PaymentDate\":\"2022-05-10T00:00:00\",\"NameContributor\":\"Ana Victoria\",\"DocumentNumber\":30241,\"ReceiptUrl\":\"http://www.pdfurl.com.br/pdf?filename=2022-04-08/btd2jeop.pdf\",\"ReturnMessage\":null,\"ReturnCode\":null,\"PaymentAuthentication\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"Status\":0,\"ProtocolId\":\"340705113ad941558733510aa840a0b3\",\"CreationDate\":\"0001-01-01T00:00:00\",\"Tags\":null,\"Description\":null}"
}