Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Pix Key Claim and Portability

ClaimPixKey

This method can be used to claim a pix key ownership or to request portability of a pix key.

post/ClaimPixKey

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
PixKeystring required
TaxNumberstring required

Legal Identification From Company

PixKeyTypeinteger required

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

BankBranchstring required

Beneficiary's Bank Branch

BankAccountstring required

Beneficiary's Account Number (without digit)

BankAccountDigitstring required

Beneficiary's Account Digit

DeviceIdstring

Example request

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

Response

OK

Successstring
Messagestring
Keystring

Example response

{
  "Success": "true",
  "Message": "Solicitação de reivindicação/portabilidade de Chave PIX registrada com sucesso",
  "Key": "69229016063"
}