4.2 Change QRCode

Change Dynamic Pix QRCode

API Method = ChangeDynamicPixQRCode

Changes the parameters of a charge with Dynamic QrCode.
You can modify the payer information, charged amount and expiration date.

{
     "Method": "ChangeDynamicPixQRCode",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "PixKey": "17699384008",
     "TaxNumber": "84928589076",
     "PayerTaxNumber": "65023491021",
     "PayerName": "João da Silva Pereira",
     "PrincipalValue": 123.45,
     "ExpirationDate": "31/01/2022",
     "Address": {
          "AddressLine": "Rua Niterói",
          "AddressLine2": "string",
          "ZipCode": "60731-305",
          "Neighborhood": "Canindezinho",
          "CityCode": "451",
          "CityName": "Fortaleza",
          "State": "Ceará",
          "AddressType": 1,
          "Country": "Brasil",
          "Complement": "Apto 01",
          "Reference": "Próximo ao mercado"
     },
     "ChangeType": 0,
     "AdditionalData": [
          {
               "Name": "pagamento",
               "Value": "300"
          }
     ],
     "PayerRequest": "pagamento",
     "DocumentNumber": 854127,
     "TransactionPurpose": 1,
     "TransactionValue": null,
     "TransactionChangeType": null,
     "AgentModality": 2
}

Description

Parameter	Description	Mandatory	Type	Comments
Method	ChangeDynamicPixQRCode	YES	STRING	-
PartnerId	Information provided by FitBank	YES	INT	-
BusinessUnitId	Information provided by FitBank	YES	INT	-
PixKey	Receiver's PIX key	YES	STRING	-
TaxNumber	CPF/CNPJ of the collector/receiver, meaning, who will have the PIX key and generates the charge	NO	STRING	-
PayerTaxNumber	CPF/CNPJ of the payer	NO	STRING	-
PayerName	Name of the payer	NO	STRING	-
PrincipalValue	Value of the collection	YES	NUMBER	-
ExpirationDate	Date until the transaction expires	NO	STRING	-
Address	Adress of the receiver	NO	OBJECT	-
AddressLine	First adress of the receiver	NO	STRING	-
AddressLine2	Second adress of the receiver	NO	STRING	-
ZipCode	ZipCode of the receiver	NO	STRING	Valid Formats: 61801490 61801-490 Limit: 10 characters
Neighborhood	Neighborhood of the receiver	NO	STRING	-
CityCode	City code of the receiver	NO	STRING	-
CityName	City of the receiver	NO	STRING	-
State	State of the receiver	NO	STRING	-
AddressType	Type of adress of the receiver	NO	INT	Commercial = 0 Residential = 1
Country	Country of the receiver	NO	STRING	-
Complement	Aditional information to the adress of the receiver	NO	STRING	-
Reference	Reference to the adress of the receiver	NO	STRING	-
ChangeType	Parameter that allows the amount charged to be changed or not at the moment of payment	YES	INT	None = 0 (Does not allow value change) Allowed = 1 (Allows value change)
AdditionalData	Additional information of the collection	NO	ARRAY OF OBJECTS	-
Name	Name of the custom parameter to be add with transaction	NO	STRING	-
Value	Value of the custom parameter to be add with transaction	NO	STRING	Does not necessarily have to be the indication of a monetary value
PayerRequest	Message or description that can be added if desirable	NO	STRING	Maximum number of accepted characters: 140 characters
DocumentNumber	Document number (ID) of the dynamic QrCode from which you want to change information	YES	NUMBER	-
TransactionPurpose	Purpose of the collection	NO	INT	PurchaseOrTransfer = 0 PurchaseWithChange = 1 Withdraw = 2 For a common payment transaction, by default fill as 0
TransactionValue	Value of the transaction	NO	NUMBER	Applicable only if the QrCode is set as PIX Withdraw or PIX Change. If not, must be filled as null
TransactionChangeType	Type of the collection transaction	NO	INT	None = 0 Allowed = 1 Applicable only if the QrCode is set as PIX Withdraw or PIX Change. If not, must be filled as null
AgentModality	Agent modality of the withdraw transaction	NO	INT	PSS = 0 (Withdrawal Service Provider) CommercialEstablishment = 1 Other = 2 By default, fill as 2, unless it refers to a PIX Withdraw transaction

Change Dynamic Pix QRCode Due Date

API Method = ChangeDynamicPixQRCodeDueDate

This method can be used to modify dynamic PIX QrCode information. You can modify the payer information, charged amount, expiration date and due date.

{
     "Method": "ChangeDynamicPixQRCodeDueDate",
     "PartnerId": 30519,
     "BusinessUnitId": 51138,
     "TaxNumber": "84928589076",
     "PayerRequest": "pagamento",
     "PayerTaxNumber": "65023491021",
     "PayerName": "João da Silva Pereira",
     "PrincipalValue": 123.45,
     "PixKey": "17699384008",
     "Address": {
          "AddressLine": "Rua Niterói",
          "AddressLine2": "string",
          "ZipCode": "60731-305",
          "Neighborhood": "Canindezinho",
          "CityCode": "451",
          "CityName": "Fortaleza",
          "State": "Ceará",
          "AddressType": 1,
          "Country": "Brasil",
          "Complement": "Apto 01",
          "Reference": "Próximo ao mercado"
     },
     "DueDate": "2022/10/29",
     "ExpirationDate": "2022/10/30",
     "RebateValue": 0,
     "InterestValue": 0,
     "FineValue": 0,
     "AdditionalData": [
          {
               "Name": "pagamento",
               "Value": "300"
          }
     ],
     "DocumentNumber": 854127
}

Description

Parameter	Description	Mandatory	Type	Comments
Method	ChangeDynamicPixQRCodeDueDate	YES	STRING	-
PartnerId	Information provided by FitBank	YES	INT	-
BusinessUnitId	Information provided by FitBank	YES	INT	-
TaxNumber	CPF/CNPJ of who will have the PIX key	YES	STRING	-
PayerRequest	Message or description that can be added if desirable	NO	STRING	Maximum number of accepted characters: 140 characters
PayerTaxNumber	CPF/CNPJ of the payer	YES	STRING	-
PayerName	Name of the payer	YES	STRING	-
PrincipalValue	Value of the collection	YES	NUMBER	-
PixKey	Receiver's PIX key	YES	STRING	-
Address	Adress of the receiver	NO	OBJECT	-
AddressLine	First adress of the receiver	NO	STRING	-
AddressLine2	Second adress of the receiver	NO	STRING	-
ZipCode	ZipCode of the receiver	NO	INT	Valid Formats: 61801490 61801-490 Limit: 10 characters
Neighborhood	Neighborhood of the receiver	NO	STRING	-
CityCode	City code of the receiver	NO	STRING	-
CityName	City of the receiver	NO	STRING	-
State	State of the receiver	NO	STRING	-
AddressType	Type of adress of the receiver	NO	INT	Commercial = 0 Residential = 1
Country	Country of the receiver	NO	STRING	-
Complement	Aditional information to the adress of the receiver	NO	STRING	-
Reference	Aditional information to the adress of the receiver	NO	STRING	-
DueDate	Date until the transaction can be paid without any fine or interest	NO	STRING	-
ExpirationDate	Date until the transaction expires	NO	STRING	-
RebateValue	Discount value	NO	NUMBER	To be applied if the payment is done before due date
InterestValue	Interest value	NO	NUMBER	To be applied if the payment is done after due date
FineValue	Fine value	NO	NUMBER	To be applied if the payment is done after due date
AdditionalData	Aditional information of the collection	NO	ARRAY OF OBJECTS	-
Name	Name of the custom parameter to be add with transaction	NO	STRING	-
Value	Value of the custom parameter to be add with transaction	NO	STRING	Does not necessarily have to be the indication of a monetary value
DocumentNumber	Document number (ID) of the dynamic QrCode due date from which you want to change information	YES	NUMBER	-