v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB

QRCode Management

GenerateDynamicPixQRCode

This method can be used to generate a dynamic Pix QRCode transaction

post/GenerateDynamicPixQRCode

Request body

Methodstring required

PartnerIdinteger required

Partner identifier provided by Fitbank

BusinessUnitIdinteger required

PixKeystring required

TaxNumberstring required

Legal Identification From Company

PayerTaxNumberstring

PayerNamestring

PrincipalValuenumber float required

Collection Order Value

ExpirationDatestring date

Expiration Date (format YYYY-MM-DD)

BankBranchstring required

Beneficiary's Bank Branch

BankAccountstring required

Beneficiary's Account Number (without digit)

BankAccountDigitstring required

Beneficiary's Account Digit

ChangeTypeinteger required

None = 0 Allowed = 1

PayerRequeststring

TransactionPurposeinteger

PurchaseOrTransfer = 0 PurchaseWithChange = 1 Withdraw = 2

TransactionValuenumber

AgentModalityinteger

Pss = 0 CommercialEstablishment = 1 Other = 2

TransactionChangeTypeinteger

None = 0 Allowed = 1

Identifierstring

Example request

{
  "Method": "GenerateDynamicPixQRCode",
  "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",
  "TransactionPurpose": 1,
  "TransactionValue": 100,
  "AgentModality": 1,
  "Identifier": "eriu3743-djf36dg-eyrsgfjs3642-324rsdf",
  "Recurrence": {
    "Retry": true
  }
}

Response

Successstring

Messagestring

DocumentNumberinteger

Transaction id

ExpirationDatestring date

Expiration Date (format YYYY-MM-DD)

ConciliationIdstring

HashCodestring

QRCodeBase64string

RecurrenceIdstring

The RecurrenceId field will be returned when the generated QR Code is associated with an Automatic Pix recurrence

Example response

{
  "Success": "true",
  "Message": "ISI0001 - Método executado com sucesso",
  "DocumentNumber": 656,
  "ExpirationDate": "2022-10-25",
  "ConciliationId": "21s88c5832a7899",
  "RecurrenceId": "RN1320335420260302254f3fb4263"
}