v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Queries

Get FGTS Out By Id

Returns a FGTS payment by document number.

post/GetFGTSOutById

Request body

Methodstring required

PartnerIdinteger required

Number Of The Partner

BusinessUnitIdinteger required

Number Of The BusinessUnit

DocumentNumberinteger required

Transaction id

Example request

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

Response

Successboolean

FGTSstring

Messagestring

Validationobject

Example response

{
  "FGTS": "{\"TaxNumber\":\"33109855046\",\"ReferenceNumber\":0,\"PrincipalValue\":168.67,\"CodeRevenue\":\"4321\",\"Barcode\":\"03394894500000087671760680778200262003064000\",\"FgtsIdentifier\":\"9\",\"SocialConnectivityCode\":0,\"SocialConnectivityDigit\":0,\"TotalValue\":168.67,\"Status\":0,\"WasAuthorized\":false,\"PaymentDate\":\"2022-05-16T00:00:00\",\"ContributorTaxNumber\":\"33109855046\",\"NameContributor\":\"Ana Victoria\",\"PaymentAuthentication\":null,\"ReceiptUrl\":\"http://www.pdfurl.com.br/pdf?filename=2022-04-08/xmxnphdu.pdf\",\"ReturnMessage\":null,\"ReturnCode\":null,\"SenderNameBank\":\"Santander\",\"SenderCodeBank\":\"033\",\"SenderBranch\":\"0120\",\"SenderAccount\":\"013003522\",\"SenderAccountDigit\":\"9\",\"ProtocolId\":\"a29dd9ff217b42289ff94f72de9cfdcf\",\"DocumentNumber\":20252,\"CreationDate\":\"0001-01-01T00:00:00\",\"Tags\":null,\"Description\":null}"
}