Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Payment and Payment Management

GetPixOutByDate

This method can be used to consult a Pix Out transaction by date

post/GetPixOutByDate

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
TaxNumberstring required

Legal Identification From Company

BankBranchstring required

Beneficiary's Bank Branch

BankAccountstring required

Beneficiary's Account Number (without digit)

BankAccountDigitstring required

Beneficiary's Account Digit

StartDatestring date required

Start date of the query

EndDatestring date required

End date of the query

PageIndexinteger required

Index of the page starting in 0

PageSizeinteger required

Number of records to return per page

Example request

{
  "Method": "GetPixOutByDate",
  "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": "true",
  "Message": "Método executado com sucesso.",
  "PixOutList": [
    {
      "Identifier": "33gsd183-sdh237-dhds238sdh-327sdhs7",
      "EndToEndId": "E28347346198237738881630101",
      "FromName": "José da Silva",
      "FromTaxNumber": "12312312312",
      "FromBankCode": "450",
      "FromBankBranch": "1234",
      "FromBankAccount": "12345",
      "FromBankAccountDigit": "1",
      "ToName": "Maria José",
      "ToTaxNumber": "12345678978",
      "ToBankCode": "450",
      "ToBankBranch": "1234",
      "ToBankAccount": "12345",
      "ToBankAccountDigit": "1",
      "Status": "Settled",
      "ReceiptUrl": "https://receipturl/receipt.pdf",
      "PaymentDate": "2022/08/26 11:46:22"
    }
  ]
}