Sign in

v1

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

GetPixOutById

This method can be used to consult a pix payment by its identifier (DocumentNumber)

post/GetPixOutById

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": "GetPixOutById",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "DocumentNumber": 656,
  "TaxNumber": "33.762.255/0001-40",
  "Identifier": "PurchaseTest1106new4"
}

Response

OK

Successstring
Messagestring

Example response

{
  "Success": "true",
  "Message": "Método executado com sucesso.",
  "Infos": [
    {
      "DocumentNumber": 12345,
      "Identifier": "5asd534asd53asdas534edf43",
      "EndToEndId": "null",
      "FromName": "José da Silva",
      "FromTaxNumber": "12312312312",
      "FromISPB": "123",
      "FromBankCode": "123",
      "FromBankBranch": "12345",
      "FromBankAccount": "12345",
      "FromBankAccountDigit": "1",
      "ToName": "Maria José",
      "ToTaxNumber": "12345678988",
      "ToISPB": "1234",
      "ToBankCode": "1234",
      "ToBankBranch": "1234",
      "ToBankAccount": "12345",
      "ToBankAccountDigit": "1",
      "Status": "Settlement",
      "RateValue": "0.00",
      "TotalValue": "0.01",
      "PaymentDate": "26/04/2022 11:26:44",
      "ReceiptValue": "https://receipt.fitbank.com.br/receiptapi/pdf?filename=2022-08-26/receipt.pdf"
    }
  ]
}