Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Key Management

GetPixKeyStatus

This method can be used to query the status of a pix key linked to an account

post/GetPixKeyStatus

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
PixKeystring 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

PixKeyTypeinteger required

SocialSecurity = 0 TaxNumber = 1 Email = 2 PhoneNumber = 3 RamdomKeyCode = 4

Example request

{
  "Method": "GetPixKeyStatus",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "PixKey": "17699384008",
  "TaxNumber": "33.762.255/0001-40"
}

Response

OK

Successstring

Example response

{
  "Success": "true",
  "GetPixKeyStatusInfo": {
    "PixKey": "17699384008",
    "PixKeyType": "0",
    "Status": "2",
    "TaxNumber": "33.762.255/0001-40",
    "Name": "Maria Júlia Soares"
  }
}