通过授权密钥查询授权

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"
        }
    ]
}

授权对象

字段	类型	描述
authorization_key	string	授权的唯一标识符
merchant_currency_code	string	交易使用的货币 - ISO 4217-alpha
original_merchant_amount	decimal	交易发生货币下的原始交易金额
billing_currency_code	string	持卡人账单货币 - ISO 4217-alpha
original_billing_amount	decimal	持卡人账单货币下的原始交易金额
merchant_amount	decimal	所有授权请求中交易货币金额的汇总
iof_amount	decimal	当交易货币与持卡人账单货币不同时，汇兑所缴纳的 IOF 金额汇总
billing_amount	decimal	所有授权请求中持卡人账单货币金额的汇总
processing_datetime	datetime UTC	授权对象的创建时间，通常为第一次授权请求的时间
captured_amount	decimal	所有授权请求已捕获的总金额
authorization_status	enumerator	授权状态枚举
card	object	Card 对象
balance_transactions	list of objects	Balance Transaction 对象
authorization_requests	list of objects	授权请求对象
authorization_events	list of objects	授权事件对象

Card 对象

字段	类型	描述
card_key	string	卡片识别密钥
account_key	string	持卡人账户标识符
type	string	卡片类型
card_name	string	卡片字母数字标识符
printed_name	string	印在卡片上的姓名
cvv_rotation_interval_hours	int	CVV 轮换间隔
status	string	卡片当前状态
brand	string	卡片所属卡组织
bin	string	卡片 BIN
last_four_digits	string	卡号后四位

Balance Transaction 对象

Balance Transaction 对象表示持卡人 QI Conta 上需要执行的任何资金变动。可以是因授权获批而产生的借记交易，也可以是授权取消等场景下的贷记交易。

字段	类型	描述
balance_transaction_key	string	交易的唯一标识符
balance_transaction_type	enumerator	贷记时为 credit，借记时为 debit
account_key	string	与所用卡片关联的 QI Conta 标识符
merchant_currency_code	string	交易使用的货币 - ISO 4217-alpha
merchant_amount	decimal	交易货币下的等值收费金额
billing_currency_code	string	持卡人账单货币 - ISO 4217-alpha
billing_amount	decimal	持卡人账单货币下的交易金额
processing_datetime	datetime	交易的处理和创建日期。由于 QI Conta 中的实际交易可能不会发生，此值作为收费或贷记生成时的参考时间
balance_transaction_status	enumerator	描述交易是否已在持卡人 QI Conta 上执行，可能为待处理（`pending_transaction_execution`）、部分交易（`partially_transacted`）或已交易（`transacted`）
transacted_amount	decimal	已在 QI Conta 上执行的借记或贷记的持卡人货币总金额

授权请求对象

详见授权请求

授权事件对象

Authorization Event 对象表示授权上发生的事件。更详细的说明请参阅手册。

字段	类型	描述
merchant_currency_code	string	交易使用的货币 - ISO 4217-alpha
merchant_amount	decimal	交易货币下的等值收费金额
billing_currency_code	string	持卡人账单货币 - ISO 4217-alpha
billing_amount	decimal	持卡人账单货币下的事件金额
processing_datetime	datetime	事件的处理日期
authorization_event_type	enumerator	授权事件类型

授权状态

状态	描述
pending	授权请求已获批准，尚无捕获或取消事件被处理
unauthorized	授权请求未获批准
completed	对该授权至少已成功捕获一个金额（可等于、小于或大于所有授权请求中批准的总金额）
reversed	授权已被完全冲正，或已过期而未捕获

授权事件类型

类型	描述
authorization	通知一次授权请求已被响应
incremental_authorization	通知一次增量授权请求已被响应
authorization_reversal	通知一次授权取消已被处理
partial_authorization_reversal	通知一次部分授权取消已被处理
authorization_expiration	通知一次授权已过期
capture	通知一笔特定金额已为某授权完成捕获
refund	通知一次授权已被退款
partial_refund	通知一次授权已被部分退款

Request​

Response​

授权对象​

Card 对象​

Balance Transaction 对象​

授权请求对象​

授权事件对象​

授权状态​

授权事件类型​