v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

QRCode Management

ChangeDynamicPixQRCode

This method can be used to modify a dynamic Pix QRCode data

post/ChangeDynamicPixQRCode

Request body

Methodstring required

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

PixKeystring required

TaxNumberstring

Legal Identification From Company

PayerTaxNumberstring

PayerNamestring

PrincipalValuenumber float required

Collection Order Value

ExpirationDatestring date

Expiration Date (format YYYY-MM-DD)

ChangeTypeinteger required

None = 0 Allowed = 1

PayerRequeststring

DocumentNumberinteger required

Transaction id

TransactionPurposeinteger

PurchaseOrTransfer = 0 PurchaseWithChange = 1 Withdraw = 2

TransactionValuenumber

TransactionChangeTypeinteger

None = 0 Allowed = 1

AgentModalityinteger

Pss = 0 CommercialEstablishment = 1 Other = 2

Example request

{
  "Method": "ChangeDynamicPixQRCode",
  "PartnerId": 30324,
  "BusinessUnitId": 51138,
  "PixKey": "17699384008",
  "TaxNumber": "33.762.255/0001-40",
  "PayerTaxNumber": "16982097030",
  "PayerName": "João Alves",
  "PrincipalValue": 5,
  "ExpirationDate": "2022-10-25",
  "AdditionalData": [
    {
      "Name": "pagamento",
      "Value": "300"
    }
  ],
  "PayerRequest": "pagamento",
  "DocumentNumber": 656,
  "TransactionPurpose": 1,
  "TransactionValue": 100,
  "TransactionChangeType": 1,
  "AgentModality": 2
}

Response

Successstring

Messagestring

ChangeDocumentNumberinteger

Transaction id

Example response

{
  "Success": "true",
  "Message": "ISI0001 - Método executado com sucesso",
  "ChangeDocumentNumber": 656
}