QR Codes Pix

Criar cobrança imediata

post/pix/qrcode/collection/immediate

Request

  • Base URL
    https://api.transfeera.com
  • URL
    https://api.transfeera.com/pix/qrcode/collection/immediate
  • Auth
    HTTP bearer

Headers

User-Agentstring

Todas as requests para a API da Transfeera deve conter o Header "User-Agent". Use este Header para nos dizer qual o nome da sua empresa e um e-mail para contato

Request body

txidstring

Deve conter entre 26 e 35 caracteres, no formato [A-Za-z0-9]

integration_idstring

ID de integração

location_idstring uuid

Identificador da location associada ao QR Code. Uma location é para onde a imagem do QR Code (impressa ou exibida) aponta, portanto a mesma imagem impressa pode ser reutilizada em várias cobranças.

Ao criar um QR Code:

  • Se location_id for omitido, uma nova location é criada automaticamente e seu id é retornado na resposta.
  • Se location_id for informado, a location existente é reutilizada. Para garantir que uma única location esteja sempre associada a no máximo um QR Code por vez, qualquer outro QR Code que esteja previamente vinculado a ela é automaticamente desvinculado.
pix_keystring required

Chave Pix registrada na Transfeera

original_valuenumber required

Valor original

payer_questionstring

Informação adicional para o pagador

reject_unknown_payerboolean

Rejeitar pagamento de desconhecido

expirationinteger

Padrão 86400, tempo de expiração em segundos após criação

value_change_mode'VALOR_FIXADO' | 'MODIFICAVEL'
withdrawobject

Campos de Pix saque (entre em contato com suporte para utilizar)

changeobject

Campos de Pix troco (entre em contato com suporte para utilizar)

Response

Successful response

idstring
qrcode_type'ESTATICO' | 'COBRANCA_IMEDIATA' | 'COBRANCA_COM_VENCIMENTO'
status'ATIVA' | 'CONCLUIDA' | 'REMOVIDA_PELO_USUARIO_RECEBEDOR' | 'REMOVIDA_PELO_PSP'
txidstring
integration_idstring
location_idstring uuid

Identificador da location associada ao QR Code.

expirationinteger
original_valuenumber
value_change_mode'MODIFICAVEL' | 'VALOR_FIXADO'
withdrawobject
changeobject
payer_questionstring
reject_unknown_payerboolean
emv_payloadstring
image_base64string
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.