v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Queries

Get Boleto Out By Id

Returns a boleto out by document number.

post/GetBoletoOutById

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

DocumentNumberinteger required

Transaction id

Example request

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

Response

Successboolean

Titulostring

Messagestring

Validationobject

Example response

{
  "Titulo": "{\"Barcode\":\"03394894500000087671760680778200262003064000\",\"DueDate\":\"2022-04-04T00:00:00\",\"PaymentDate\":\"2022-04-18T00:00:00\",\"PrincipalValue\":87.67,\"InterestValue\":0.00,\"FineValue\":0.0,\"TotalValue\":87.67,\"DiscountValue\":0.00,\"ExtraValue\":0.00,\"PaymentValue\":87.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentAuthentication\":null,\"ReceiptUrl\":\"http://www.pdfurl.com.br/pdf?filename=2022-04-04/omu1tvh3.pdf\",\"ReturnMessage\":null,\"ReturnCode\":null,\"ReturnErrorMessage\":null,\"ReturnErrorCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"c112e4ce6515435d8ff61aa57236bd50\",\"DocumentNumber\":142578,\"CreationDate\":\"0001-01-01T00:00:00\",\"Tags\":null,\"Description\":null}"
}