Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Instant Payment Refund

GetRefundPixInByDate

This method can be used to consult a refund pix in transaction by date

post/GetRefundPixInByDate

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 Number (without digit)

PageIndexinteger

Index of the page starting in 0

PageSizeinteger

Number of records to return per page

Example request

{
  "Method": "GetRefundPixInByDate",
  "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

Example response

{
  "Success": "true",
  "RefundPixInList": [
    {
      "DocumentNumber": 1,
      "EndToEndId": "ESD23432ESD23SDFGASD230",
      "RefundPixInReason": "MD06 - Devolução de pagamento instantâneo solicitado pelo usuário recebedor",
      "CustomerMessage": "Mensagem Customizada do Cliente",
      "FromName": "José da Silva",
      "FromTaxNumber": "12345678978",
      "FromBankCode": "450",
      "FromBankBranch": "1234",
      "FromBankAccount": "132456",
      "FromBankAccountDigit": "1",
      "ToName": "Maria José",
      "ToTaxNumber": "1234567878",
      "ToBankCode": "123",
      "ToBankBranch": "1234",
      "ToBankAccount": "12345",
      "ToBankAccountDigit": "1",
      "RateValue": "0.05",
      "TotalValue": "0.06",
      "RefundDate": "26/04/2022 11:26:44",
      "Identifier": "78asda87-da7sda-das7da-7894657850",
      "Status": "Settled",
      "ReceiptUrl": "2022-03-09/heishurw.pdf",
      "FromISPB": "2022-03-09/heishurw.pdf",
      "ToISPB": "2022-03-09/heishurw.pdf"
    }
  ]
}