Criação de QR Code com Vencimento

Através deste endpoint é possível criar um QR Code para pagamento com vencimento.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Corpo do Request

CampoTipoObrigatórioDescrição
reusablebooleanNãoIndica se o QR Code é reutilizável.
keyIdentifierStringNãoIdentificador da chave. Mutuamente excludente com keyValue.
keyValueDoubleNãoValor da chave. Mutuamente excludente com keyIdentifier.
additionalInformationArrayNãoInformações adicionais.
└── nameStringSimNome da informação adicional.
└── valueDoubleSimValor da informação adicional.
personPayerObjectSimInformações do pagador
└── streetNameStringSimNome da rua do pagador
└── cityStringSimCidade do pagador
└── postalCodeStringSimCódigo postal do pagador
└── ufStringSimEstado do pagador
└── emailStringSimEmail do pagador
└── documentNumberStringSimNumero do documento do pagador
└── nameStringSimNome do pagador
└── tradingNameStringSimNome comercial do pagador
discountsArrayNãoLista de descontos
└── dateDateSimdata do desconto
└── valueDoubleSimValor do desconto
valueDoubleSimValor da transação
interestValueDoubleNãovalor de juros
interestTypeEnumNãoTipo de juros
discountValueDoubleNãoValor do desconto
discountTypeEnumNãoTipo do desconto
fineValueDoubleNãoValor de multa
fineTypeEnumNãoTipo de multa
reductionValueDoubleNãoValor do abatimento
reductionTypeEnumNãoTipo do abatimento
dueDateDateSimData de vencimento
daysToExpireIntSimDias para expiração a partir da data de vencimento
descriptionStringNãoDescrição da transação
transactionIdentifierStringSimIdentificador da transação
urlNotificationStringSimUrl de notificação de status da transação
splitTaxTypeEnumNãoInforma o tipo de cobrança no split (PERCENTAGE ou FIXED), cobrará de acordo com o informado. PercentualValue será em R$ ou %.
splitsArrayNãoInformações sobre a divisão de valores.
└── accountIdentifierStringSimIdentificador da conta.
└── percentualValueNumberSimPercentual do valor.
└── taxNumberNãoValor da taxa.
└──absorbsTaxDifferencebooleansimCaso o valor ultrapasse devido aos juros e multa, se irá cobrar desse participante o restante da taxa.
└──absorbsValueDifferencebooleansimCaso o valor ultrapasse devido aos juros e multa, se irá repassar o restante do valor para esse participante

Exemplo de requisição

{
  "reusable": false,
  "keyIdentifier": "990f6a80-6e82-4d6d-ad12-269bb65a65a6",
  "keyValue": "keyValue_afcd6a4ba24a",
  "additionalInformation": [
    {
      "name": "name_3881a1c5e521",
      "value": "value_77032fdd1cc9"
    }
  ],
  "personPayer": {
    "streetName": "streetName_0a83cbfe6761",
    "city": "city_7e2927150416",
    "postalCode": "postalCode_123a2e09833b",
    "uf": "uf_9282e2010dde",
    "email": "email_0e5ded5dd979",
    "documentNumber": "documentNumber_7a0e879a7dbc",
    "name": "name_a714d1c2beea",
    "tradingName": "tradingName_c92fb4ea9baf"
  },
  "discounts": [
    {
      "date": "2024-12-09",
      "value": 0.00
    }
  ],
  "value": 0.00,
  "interestValue": 0.00,
  "interestType": "VALUE_PER_DAY",
  "discountValue": 0.00,
  "discountType": "FIXED_VALUE_UNTIL_THE_DATE",
  "fineValue": 0.00,
  "fineType": "FIXED_VALUE",
  "reductionValue": 0.00,
  "reductionType": "FIXED_VALUE",
  "dueDate": "2024-12-09",
  "daysToExpire": 0,
  "description": "description_dfff8f3a2b99",
  "transactionIdentifier": "transactionIdentifier_54cb5e7fea53",
  "urlNotification": "urlNotification_c3a08cd75d31",
  "hybridBill": false,
	"splitTaxType": "FIXED",
  "splits":[
    {
      "accountIdentifier":"030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
      "percentualValue":0.5,
      "tax":0.5
    },
    {
      "accountIdentifier":"030fb86b-6c4e-4b0b-9c2a-1dedf1061f35",
      "percentualValue":0.5,
      "tax":0.5
    }
  ]
}

Corpo do response

CampoTipoDescrição
identifierStringIdentificador da transação
descriptionStringDescrição da transação
copyAndPasteStringCódigo de barras da transação
valueDoublevalor da transação
expirationDateDateData de expiração da transação
keyStringChave da transação
keyTypeStringTipo de chave
Body Params
boolean
string
string
additionalInformation
array of objects
additionalInformation
personPayer
object
required

Dados do pagador

discounts
array of objects

Descontos associados ao QR Code

discounts
double

Valor da transação

double

valor de juros

string
enum

Tipo de juros

double

valor de desconto

string
enum

Tipo de desconto

Allowed:
double

Valor da multa

string
enum

Tipo de multa

Allowed:
double

Valor do abatimento

string
enum

Tipo do abatimento

Allowed:
date

Data de vencimento da transação

int32

Dias para expiração pós data de vencimento

string

Descrição da transação (máximo de caracteres 140).

string

Identificador da transação

string

Url para notificação do status da transação

Headers
string
required

Identificador da conta que deseja associar ao QR code com vencimento que será criado

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json