Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Instant Receipt Management

GetPixInByDate

This method can be used to consult a Pix In (pix receipt) by date

post/GetPixInByDate

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
TaxNumberstring required

Legal Identification From Company

StartDatestring date required

Start date of the query

EndDatestring date required

End date of the query

BankBranchstring required

Beneficiary's Bank Branch

BankAccountstring required

Beneficiary's Account Number (without digit)

BankAccountDigitstring required

Beneficiary's Account Digit

PageIndexinteger

Index of the page starting in 0

PageSizeinteger

Number of records to return per page

Example request

{
  "Method": "GetPixInByDate",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "TaxNumber": "33.762.255/0001-40",
  "StartDate": "2023-09-09",
  "EndDate": "2023-10-09",
  "PageIndex": 2,
  "PageSize": 10
}

Response

OK

Successstring
Messagestring

Example response

{
  "Success": "GetPixInByDate",
  "Message": "Método executado com sucesso.",
  "PixInList": [
    {
      "DocumentNumber": 14,
      "EndToEndId": "E28347346198237738881630101",
      "CustomerMessage": "Mensagem customizada PIX",
      "FromName": "José da Silva",
      "FromTaxNumber": "12345678978",
      "FromISPB": "123",
      "FromBankCode": "123",
      "FromBankBranch": "1234",
      "FromBankAccount": "12345",
      "FromBankAccountDigit": "1",
      "ToName": "Maria José",
      "ToTaxNumber": "12312313212",
      "ToISPB": "132",
      "ToBankCode": "132",
      "ToBankBranch": "1234",
      "ToBankAccount": "12345",
      "ToBankAccountDigit": "1",
      "TotalValue": 10,
      "PaymentDate": "2022/08/26 11:46:22",
      "Status": "Settled",
      "QRCodeInfos": {
        "DocumentNumber": "123",
        "Type": "Dinâmico com Vencimento",
        "ConciliationId": "7D68516956510638997C00B010",
        "InitiatorIdentifier": "null",
        "Payer": {
          "Name": "Juliano Fernandes",
          "TaxNumber": "24968355011"
        }
      }
    }
  ]
}