授权请求(可选)
程序配置完成、持卡人已添加并拥有一张有效卡片后,该卡片即可在世界各地的多个销售点进行消费。每当在某个受理终端发起交易时,系统将创建一个 Authorization(授权)来授权该操作。系统将向客户系统发送 Authorization Request(授权请求),由客户根据请求中包含的信息决定是否批准该授权。
Authorization 实体包含已授权和已捕获金额的当前状态,可取以下状态值:
| 状态 | 描述 |
|---|---|
| pending | 授权请求已获批准,尚无捕获或取消事件被处理 |
| unauthorized | 授权请求未获批准 |
| completed | 对该授权至少已成功捕获一个金额(可等于、小于或大于所有授权请求中批准的总金额) |
| reversed | 授权已被完全冲正,或已过期而未捕获 |
授权字段详情请参阅查询授权
发送给客户的 Authorization Request 将包含认证头信息,其结构如下:
授权请求
ENDPOINT
(client_url)/authorization_requestMETODO
POSTRequest Body
{
"authorization_key": "c91ce179-517c-48f9-9c28-18368457b67f",
"authorization_request_key": "cccbd9e9-863f-44b5-aa05-f6afa555bb74",
"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"
},
"terminal_id": "123456",
"terminal_country_code": "BRA",
"terminal_type": "2",
"terminal_pin_entry_capability": true,
"terminal_magnetic_stripe_capability": true,
"terminal_contactless_capability": false,
"terminal_chip_capability": true,
"merchant_acquirer_code": "250",
"merchant_code": "123456",
"merchant_name": "VASP LINHAS AEREAS",
"merchant_street": "RUA CMDTE X, 127",
"merchant_city": "SAO PAULO, SP",
"merchant_region": "BRA",
"merchant_postal_code": "04570-140",
"merchant_mcc": "3036",
"authorization_code": "473890",
"nsu": "123456",
"acquirer_reference_number": "12312423",
"merchant_currency_code": "BRL",
"merchant_amount": 10.59,
"billing_currency_code": "BRL",
"billing_amount": 10.59,
"processing_datetime": "2023-01-10T13:45:52.000Z",
"number_of_installments": 1,
"authorization_type": "authorization",
"pan_entry_mode": "chip",
"pin_sent": true,
"autorization": {Objeto Autorização}
}
Authorization Request
| 字段 | 类型 | 描述 |
|---|---|---|
authorization_request_key | string | 授权请求的唯一标识符 |
authorization_key | string | 与本请求关联的授权实体的唯一标识符 |
card | object | Card 对象 |
terminal_id | string | 收单机构在授权消息中发送的终端标识符 |
terminal_country_code | string | 终端所在国家代码,依据 ISO 3166-1 alpha-3 在授权消息中发送 |
terminal_type | string | 授权消息中收到的终端类型 |
terminal_pin_entry_capability | boolean | 终端是否支持输入卡密码? |
terminal_magnetic_stripe_capability | boolean | 终端是否能读取磁条? |
terminal_contactless_capability | boolean | 终端是否能发起非接触式交易? |
terminal_chip_capability | boolean | 终端是否能使用 EMV 芯片发起交易? |
merchant_acquirer_code | string | 授权消息中收单机构的标识符 |
merchant_code | string | 授 权消息中商户在收单机构的标识符 |
merchant_name | string | 授权消息中的商户名称 |
merchant_street | string | 商户地址的街道 |
merchant_city | string | 商户地址的城市 |
merchant_region | string | 商户地址的地区 |
merchant_postal_code | string | 商户地址的邮政编码(CEP) |
merchant_mcc | string | 商户类别代码 - 识别商户类型 - 最新列表可在此处查阅 |
authorization_code | string | 6 位授权码 |
nsu | string | 定义一次授权的唯一顺序号 |
acquirer_reference_number | string | 收单机构的唯一授权标识符 |
merchant_currency_code | string | 交易使用的货币 - ISO 4217-alpha |
merchant_amount | decimal | 交易发生货币下的交易金额 |
billing_currency_code | string | 持卡人账单货币 - ISO 4217-alpha |
billing_amount | decimal | 持卡人账单货币下的交易金额 |
processing_datetime | timestamp utc | 授权请求的处理时间 |
number_of_installments | int | 本次请求授权的分期数 |
authorization_request_type | enum | 授权请求类型枚举 |
pan_entry_mode | enum | PAN 输入模式 - 芯片、手动输入、磁条、降级、非接触式 |
pin_sent | boolean | 终端是否输入了密码? |
authorization | object | 授权对象,详见 GET 授权,仅在授权类型为增量时存在。 |
Card 对象
| 字段 | 类型 | 描述 |
|---|---|---|
card_key | string | 卡片识别密钥 |
account_key | string | 持卡人账户标识符 |
type | string | 卡片类型 |
card_name | string | 卡片字母数字标识符 |
printed_name | string | 印在卡片上的姓名 |
status | string | 卡片当前状态 |
brand | string | 卡片所属卡组织 |
bin | string | 卡片 BIN |
last_four_digits | string | 卡号后四位 |
授权请求类型
| 枚举值 | 描述 |
|---|---|
| authorization | 普通授权请求 |
| incremental_authorization | 对已有授权的增量授权请求 |
| partial_reversal_authorization | 对之前交易进行部分冲正的授权,仅出现在事件中,不由客户明确授权 |
| reversal_authorization | 对之前交易进行冲正的授权,仅出现在事件中,不由客户明确授权 |
PAN 输入模式
| 枚举值 | ISO 8583 | 描述 |
|---|---|---|
| unknown | 00 | 未知的 PAN 输入模式。 |
| typed | 01 | 手动输入(键入)PAN。 |
| bar_code | 03 | 通过条形码读取器输入 PAN |
| ocr | 04 | 通过 OCR(光学字符识别)输入 PAN |
| chip | 05 | 通过集成电路卡(芯片)输入 PAN |
| track_1 | 06 | 通过卡片磁条 Track 1 输入 PAN |
| contactless | 07 | 通过非接触式 EMV 输入 PAN |
| fallback_typed | 79 | 尝试使用设备读卡器或磁条时无法处理交易(可能是设备或卡片问题),随后手动键入 PAN。某些情况下收单机构未获授权使用芯片或磁条并发送此代码。 |
| fallback_magnetic_stripe | 80 | 尝试使用设备读卡器时无法处理交易(可能是设备或卡片问题),随后改用卡片磁条。 |
| ecommerce | 81 | 电商/非当面交易 |
| magnetic_stripe | 90 | 磁条交易(卡片无芯片或设备无读卡器/未获授权) |
对授权请求的批准或拒绝响应
对授权请求的响应必须始终使用 HTTP Status 201,审批意见在 approve 字段中说明。若审批为否定,需选择一个拒绝原因枚举值,并可发送文字描述来详述拒绝原因。
ENDPOINT
(client_url)/authorization_requestMÉTODO
POSTHTTP STATUS
201Response Body
"authorization_request_response": "unauthorized",
"denial_reason": "fraud_suspicion",
"denial_reason_details": "Customer tried to perform a transaction 10 times the average transaction value."
| 字段 | 类型 | 描述 |
|---|---|---|
authorization_request_response | enum | authorized 或 unauthorized |
denial_reason | enum | 拒绝原因枚举 — 仅在 authorization_request_response 为 unauthorized 时必填 |
denial_reason_details | string | 拒绝原因的文字描述 |
拒绝原因
| 枚举值 | 描述 |
|---|---|
| insufficient_funds | 余额不足 |
| invalid_pin | PIN 无效 |
| card_blocked | 卡片已被封锁 |
| card_expired | 卡片已过期 |
| card_not_active | 卡片未激活 |
| fraud_suspicion | 疑似欺诈 |
| transaction_not_allowed | 不允许此交易 |
| invalid_amount | 金额无效 |
| generic_error | 通用错误 |