v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Queries

Get GARE Out By Id

Returns a GARE payment by document number.

post/GetGAREOutById

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

DocumentNumberinteger required

Transaction id

Example request

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

Response

Successboolean

GAREstring

Messagestring

Validationobject

Example response

{
  "GARE": "{\"TaxNumber\":\"33109855046\",\"DueDate\":\"2022-05-20T00:00:00\",\"StateRegistration\":\"67890\",\"ActiveDebit\":\"1\",\"PrincipalValue\":168.67,\"FineValue\":1230.00,\"InterestValue\":17890.00,\"TotalValue\":19288.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-10T00:00:00\",\"QuoteNumberNotification\":\"213\",\"CodeRevenue\":\"4321\",\"ContributorTaxNumber\":\"33109855046\",\"NumberReference\":\"012018\",\"NameContributor\":\"Ana Victoria\",\"PaymentAuthentication\":null,\"ReceiptUrl\":\"http://www.pdfurl.com.br/pdf?filename=2022-04-08/f3w4lwzu.pdf\",\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"Returns\":[],\"ProtocolId\":\"91846652a18742348f323178c3111339\",\"DocumentNumber\":40237,\"CreationDate\":\"0001-01-01T00:00:00\",\"Tags\":null,\"Description\":null}"
}