Sign in

v1

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

GetRefundPixOutByDate

This method can be used to consult a PIX Payment refund by date

post/GetRefundPixOutByDate

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

PageIndexinteger

Index of the page starting in 0

PageSizeinteger

Number of records to return per page

Example request

{
  "Method": "GetRefundPixOutByDate",
  "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.",
  "RefundPixOutList": [
    {
      "EndToEndId": "E28347346198237738881630101",
      "RefundCode": "MD06",
      "PixOutIdentifier": "identificadorUnicoDoCliente",
      "RefundValue": "0.01",
      "RefundDate": "2022/08/26 11:46:22",
      "CustomerMessage": "Devolução no valor de 0.01",
      "DrawerName": "José da Silva",
      "DrawerTaxNumber": "12345678900",
      "DrawerISPB": "123",
      "DrawerBankCode": "123",
      "DrawerBankBranch": "1234",
      "DrawerBankAccount": "12345",
      "DrawerBankAccountDigit": "1",
      "DraweeName": "Maria José",
      "DraweeTaxNumber": "12312312312",
      "DraweeISPB": "123",
      "DraweeBankCode": "123",
      "DraweeBankBranch": "1234",
      "DraweeBankAccount": "12345",
      "DraweeBankAccountDigit": "1"
    }
  ]
}