v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

Instant Payment Refund

GetRefundPixInById

This method can be used to consult a refund pix in transaction by its identifier (DocumentNumber)

post/GetRefundPixInById

Request body

Methodstring required

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

DocumentNumberinteger

Transaction id

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

Identifierstring

Identifier Of The Transaction

Example request

{
  "Method": "GetRefundPixInById",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "DocumentNumber": 656,
  "TaxNumber": "33.762.255/0001-40",
  "Identifier": "PurchaseTest1106new4"
}

Response

Successstring

Example response

{
  "Success": "true",
  "RefundPixIn": {
    "DocumentNumber": "123",
    "Identifier": "5as4s8e7f8a5s4a5sd8a5s4a8as",
    "EndToEndId": "null",
    "FromName": "José da Silva",
    "FromTaxNumber": "12345678902",
    "FromBankCode": "123",
    "FromBankBranch": "1234",
    "FromBankAccount": "12345",
    "FromBankAccountDigit": "1",
    "ToBankCode": "123",
    "ToBankBranch": "1234",
    "ToBankAccount": "12345",
    "ToBankAccountDigit": "1",
    "TotalValue": "100",
    "RefundDate": "26/04/2022 11:26:44",
    "Code": "MD06",
    "Reason": "MD06 - Devolução de pagamento instantâneo solicitado pelo usuário recebedor",
    "CustomerMessage": "Mensagem Customizada do Cliente",
    "FromISPB": "Mensagem Customizada do Cliente",
    "ToISPB": "Mensagem Customizada do Cliente"
  }
}