Antom, leading provider of tailored payment solutions
Contact Us
登 录

notifyCardBill

该 API 用于通知商户或合作伙伴有关卡账单的信息。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息，有关报文头的结构信息，请参阅：

注意：将每个字段（除数组外）的数据类型设置为字符串。这意味字段值必须使用双引号（" "）括起来。例如：

  • 如果字段的数据类型为整数属性，且其值为 20，设置为 "20"。
  • 如果字段的数据类型为布尔属性，且其值为 true，设置为 "true"。


入参

assetId String  REQUIRED

银行卡的唯一标识符。

更多信息：

  • 最大长度：32 字符

maskedCardNo String  REQUIRED

脱敏卡号。

更多信息：

  • 最大长度：16 字符

orderNo String  REQUIRED

发行卡支付的唯一标识符。

注意：

  • 一个订单包含同一笔支付下的所有卡授权（账单）。
  • 一个订单可包含多笔账单（如初始授权、追加授权）。
  • 该字段为系统在该支付的首次卡授权时生成。
  • 该字段不可为空，且为字母数字组合。

更多信息：

  • 最大长度：32 字符

billNo String  REQUIRED

一个订单内单笔卡授权的唯一标识符。

注意：

  • 每次卡授权生成一条账单，多条账单可归属于同一订单。
  • 该字段为系统在处理卡授权时生成。
  • 该字段不可为空，且为字母数字组合。

更多信息：

  • 最大长度：32 字符

cardNickName String  

持卡人自定义的卡昵称，可以帮助持卡人更方便地管理多张卡。

更多信息：

  • 最大长度：64 字符

transactionTime Datetime  REQUIRED

交易订单的创建时间。

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。

merchantName String  

商户名称。

更多信息：

  • 最大长度：64 字符

tradeAmount Amount  REQUIRED

订单的交易金额。

Show child parameters

inAmount Amount  

下单后流入卡账户的金额，例如退款。

Show child parameters

outAmount Amount  

下单后从卡账户流出的金额。

Show child parameters

exchangeRate String  

汇率。

公式：exchangeRate=outAmount/tradeAmount

当 outAmount.currency 和 tradeAmount.currency 相同时，如果返回该参数，其值始终为1。

billType String  REQUIRED

交易类型。当前默认值为 ​CARD_PAYMENT。

更多信息：

  • 最大长度：32 字符

tradeCountry String  

表示交易发生所在国家/地区的两位字母的 ISO-3166 代码。

更多信息：

  • 最大长度：2 字符

billStatus String  REQUIRED

交易状态。有效数值如下：

  • WAITING_CLEARANCE：待结算。
  • SUCCESS：成功。
  • FAILED：失败。
  • REFUNDED：已退款。
  • CANCELLED：取消授权。
  • PARTIAL_CANCEL：取消部分授权。
  • PARTIAL_REFUND：部分退款。
  • WAITING_DEDUCT：待扣款。

更多信息：

  • 最大长度：32 字符

billFailReason FailReason  

交易失败原因。

Show child parameters

lastUpdate String  REQUIRED

最后更新时间。

更多信息：

  • 值遵循 ISO 8601 标准格式。例如，“2019-11-27T12:01:01+08:00”。

metadata Map<String, String>  

键值格式的客户元数据。格式范围如下：

  • 密钥最大长度: 32
  • 值最大长度: 128
  • 最大密钥数: 30
  • JSON 字符串最大长度: 3096

更多信息：

  • 最大长度：3096 字符

出参

result Result  REQUIRED

接口调用的结果。

Show child parameters
API Explorer

请求

请求体

响应

响应体


BillFailReason.ErrorCode

结果码值结果码信息
CARD_BALANCE_NOT_ENOUGHF账户余额不足。
CARD_OVER_LIMITF每日/每月限额不足。
CARD_AVS_RESULTFAVS 验证失败。
CARD_ASSERT_ERRORF该卡已过期。
CARD_SECURITY_REJECTF风控拒绝。
CARD_INVALID_MERCHANTF无效商户。
UNKNOWN_EXCEPTIONF未知原因。
CARD_INVALID_AMOUNTF支付金额无效。
CARD_INVALID_CARD_NUMBERF卡号无效。
CARD_EXPIRED_CARDF卡已过期。
CARD_INCORRECT_PINFPIN 码不正确。
CARD_INVALID_TRANSACTIONF异常交易。
CARD_EXCEED_WITHDRAW_AMOUNT_LIMITF超出提现金额限制。
CARD_EXCEED_WITHDRAW_FREQUENCY_LIMITF超出提现频率限制。
CARD_VERIFICATION_FAILEDF验证失败。
CARD_EXCEED_PIN_ALLOW_NUMBERF超过允许的 PIN 尝试次数。
CARD_AUTHENTICATION_REQUIREDF需要身份验证。
CARD_CVV2_FAILUREFCVV2 验证失败。
CARD_INVALID_CARDF无效卡。
BALANCE_ACCOUNT_NOT_AVAILABLEF账户状态异常。
SYSTEM_ERRORF系统错误。