Sign in

v1

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

ReplyExternalPixKeyClaim

This method can be used to respond to a pix key claim or pix key portability request. Keys of type e-mail cannot be claimed.

post/ReplyExternalPixKeyClaim

Request body

Methodstring required
PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required
PixKeystring required
PixKeyTypeinteger required

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

TaxNumberstring required

Legal Identification From Company

Confirmationboolean required

false = 0 true = 1

Example request

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

Response

OK

Successstring
Messagestring

Example response

{
  "Success": "true",
  "Message": "Método executado com sucesso."
}