Buscar autorização pela Chave da Autorização

Request

ENDPOINT

/prepaid/card/(card_key)/authorization/(authorization_key)

MÉTODO

GET

Response

STATUS

200

Response Body

{
    "authorization_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
    "merchant_currency_code": "BRL",
    "original_merchant_amount": 25.32,
    "billing_currency_code": "BRL",
    "original_billing_amount": 25.32,
    "merchant_amount": 25.32,
    "iof_amount": 0,
    "billing_amount": 25.32,
    "processing_datetime": "2023-07-24T12:00:00.000Z",
    "captured_amount": 25.32,
    "authorization_status": "completed",
    "card": {
        "card_key": "05fd3654-1f5d-479d-ade5-64239fdf214d",
        "account_key": "595e08f0-da4e-40f7-8db4-f9a25c829818",
        "type": "virtual",
        "card_name": "ecommerce sample",
        "printed_name": "Aurora Catarina",
        "status": "active",
        "brand": "visa",
        "bin": "123456",
        "last_four_digits": "5695"
    },
    "balance_transactions": [
        {
            "balance_transaction_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
            "balance_transaction_type": "debit",
            "account_transaction_key": "595e08f0-da4e-40f7-8db4-f9a25c820000",
            "account_key": "595e08f0-da4e-40f7-8db4-f9a25c829818",
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-01-10T13:45:52.000Z",
            "balance_transaction_status": "transacted",
            "transacted_amount": 25.32,
        }
    ],
    "authorization_requests": [
        {
            "authorization_request_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
            "authorization_code": "473890",
            "nsu": "123456",
            "acquirer_reference_number": "12312423",
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-01-10T13:45:52.000Z",
            "number_of_installments": 1,
            "authorization_type": "authorization",
            "authorization_request_response": "authorized"
        }
    ],
    "authorization_events": [
        {
            "merchant_currency_code": "BRL",
            "merchant_amount": 25.32,
            "billing_currency_code": "BRL",
            "billing_amount": 25.32,
            "processing_datetime": "2023-07-24T12:00:00.000Z",
            "authorization_event_type": "authorization"
        }
    ]
}

Objeto Autorização

Campo	Tipo	Descrição
authorization_key	string	Identificador único da autorização
merchant_currency_code	string	A moeda utilizada na transação - ISO 4217-alpha
original_merchant_amount	decimal	Valor original da transação na moeda em que a transação foi realizada
billing_currency_code	string	A moeda de cobrança do portador do cartão - ISO 4217-alpha
original_billing_amount	decimal	Valor original da transação na moeda de cobrança do portador do cartão
merchant_amount	decimal	Somatório do Valor da transação na moeda em que a transação foi realizada de todas requisições de autorização
iof_amount	decimal	Somatório do valor de IOF pago no câmbio quando as moedas da transação e de cobrança do portador forem diferentes
billing_amount	decimal	Somatório do valor da transação na moeda de cobrança do portador do cartão de todas requisições de autorização
processing_datetime	datetime UTC	Horário em que o objeto de autorização foi criado, em geral, horário da primeira requisição de autorização feita
captured_amount	decimal	Somatório do valor total capturado por todas requisições de autorização
authorization_status	enumerator	Enumerador de Status da Autorização
card	object	Objeto Card
balance_transactions	list of objects	Objeto Balance Transaction
authorization_requests	list of objects	Objeto Requisição de Autorização
authorization_events	list of objects	Objeto Evento de Autorização

Objeto Card

Campo	Tipo	Descrição
card_key	string	Chave de identificação do cartão
account_key	string	Identificador da conta do titular
type	string	Tipo de cartão
card_name	string	Identificador alphanumérico do cartão
printed_name	string	Nome impresso no cartão
cvv_rotation_interval_hours	int	Intervalo de rotação do CVV
status	string	Status atual do cartão
brand	string	Bandeira do cartão
bin	string	BIN do cartão
last_four_digits	string	Últimos 4 dígitos do cartão

Objeto Balance Transaction

O objeto Balance Transaction representa qualquer movimentação na QI Conta do titular do cartão que precise ser efetuada. Podem ser transações de débito por ocasião de uma Autorização aprovada, como podem ser de crédito numa situação de cancelamento de autorização por exemplo.

Campo	Tipo	Descrição
balance_transaction_key	string	Identificador único da transação
balance_transaction_type	enumerador	credit quando se tratar de um crédito em conta e debit quando se tratar de um débito em conta
account_key	string	Identificador da QI Conta relacionada com o cartão usado na transação
merchant_currency_code	string	A moeda utilizada na transação - ISO 4217-alpha
merchant_amount	decimal	Equivalente de valor cobrado na moeda da transação
billing_currency_code	string	A moeda de cobrança do portador do cartão - ISO 4217-alpha
billing_amount	decimal	Valor da transação na moeda de cobrança do portador do cartão
processing_datetime	datetime	Representa a data de processamento e criação da transação. Como a transação efetiva na QI Conta pode não ocorrer, este valor é uma referência de quando a cobrança ou crédito foram gerados
balance_transaction_status	enumerator	Descreve se a transação foi executada na QI Conta do portador do cartão, podendo estar pendente (pending_transaction_execution), parcialmente transacionada (partially_transacted) ou transacionada (transacted)
transacted_amount	decimal	Valor total na moeda do portador do cartão do débito ou crédito que já foram executados na QI Conta

Objeto Requisição de Autorização

Detalhado em Requisição de Autorização

Objeto Evento de Autorização

O objeto Authorization Event representa os eventos que ocorrem com uma Autorização. Uma forma mais detalhada de como eles podem ocorrer está descrita em Manuais

Campo	Tipo	Descrição
merchant_currency_code	string	A moeda utilizada na transação - ISO 4217-alpha
merchant_amount	decimal	Equivalente de valor cobrado na moeda da transação
billing_currency_code	string	A moeda de cobrança do portador do cartão - ISO 4217-alpha
billing_amount	decimal	Valor do evento na moeda de cobrança do portador do cartão
processing_datetime	datetime	Representa a data de processamento do evento
authorization_event_type	enumerator	Tipos de Evento de Autorização

Status da Autorização

Estado	Descrição
pending	Requisição de autorização foi aprovada e nenhum evento de captura ou cancelamento foi processado
unauthorized	Requisição de autorização não foi aprovada
completed	Pelo menos um valor capturado com sucesso para a autorização em questão (seja um valor igual, a menor ou a maior que o valor total aprovado nas requisições de autorização)
reversed	Autorização foi estornada por completo ou expirou sem captura

Tipos de Evento de Autorização

Tipo	Descrição
authorization	Informe de que uma requisição de autorização foi respondida
incremental_authorization	Informe de que uma requisição de autorização incremental foi respondida
authorization_reversal	Informe de que um cancelamento de autorização foi processado
partial_authorization_reversal	Informe de que um cancelamento parcial de autorização foi processado
authorization_expiration	Informe de que uma autorização expirou
capture	Informe de que um determinado valor foi capturado para uma autorização
refund	Informe de que uma autorização foi reembolsada
partial_refund	Informe de que uma autorização foi reembolsada parcialmente