Antom, leading provider of tailored payment solutions
Contact Us
Log In

decide

POST /v1/risk/payments/decide

当买家在您的客户端支付时，使用该接口向蚂蚁集团请求有关是否接受该交易的实时风控建议。该接口在卡支付授权前后均可调用。

结构

报文由报文头和报文体构成，下文主要介绍报文体结构。


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

  • 如果某个字段的数据类型为 Integer 且值为 20，则将其设置为 “20”。
  • 如果某个字段的数据类型为 Boolean 且值为 true，则将其设置为 “true ”。

入参

referenceTransactionId String  REQUIRED

直接向买家提供服务或商品的商户分配的唯一ID，用于识别交易。

更多信息：

  • 最大长度：64 字符

authorizationPhase String  REQUIRED

调用 API 的时间。有效值为：

  • ​PRE_AUTHORIZATION​：表示您在卡支付授权之前发起此请求。
  • ​POST_AUTHORIZATION​​​​：表示您在卡支付授权后发起此请求。

更多信息：

  • 最大长度：16 字符

orders Array<Order>  REQUIRED

订单信息，例如商户、商品、金额和运输信息。

更多信息：

  • 最多可包含元素个数：10
Show child parameters

buyer Buyer  REQUIRED

买家信息，包括买家的 ID、姓名、电话号码和电子邮件。 

Show child parameters

actualPaymentAmount Amount  REQUIRED

指扣除折扣后买家实际需要支付的金额。

Show child parameters

paymentDetails Array<PaymentDetail>  REQUIRED

支付方式详细信息，包括支付方式类型、卡信息等。 

更多信息：

  • 最多可包含元素个数：5
Show child parameters

discountAmount Amount  

本次交易的折扣金额。

提供这些信息有助于提升欺诈检测的准确性，提高支付成功率。

Show child parameters

env Env  REQUIRED

下单环境信息，例如设备信息。

Show child parameters

出参

decision String  REQUIRED

蚂蚁集团的风控决策。有效值为：

  • ACCEPT：表示建议接受该笔支付。
  • REJECT：表示建议拒绝该笔支付。

更多信息：

  • 最大长度：16 字符

authenticationDecision String  

蚂蚁集团推荐的身份验证方法。有效值为：

  • 3D：本次交易建议使用 3D 认证。
  • NON_3D：本次交易建议使用非 3D 认证。

当 decision 的值为 ACCEPT 时，返回该参数。

更多信息：

  • 最大长度：16 字符

result Result  REQUIRED

接口调用的结果。

Show child parameters
API Explorer

请求

URL

Method
POST
请求体json
{
  "referenceTransactionId": "0656237919440001",
  "authorizationPhase": "PRE_AUTHORIZATION",
  "orders": [
    {
      "orderAmount": {
        "currency": "BRL",
        "value": 30000
      },
      "orderDescription": "Cappuccino #grande (Mika's coffee shop)",
      "referenceOrderId": "ORDER_20221114141714891",
      "merchant": {
        "referenceMerchantId": "SM_001"
      },
      "goods": [
        {
          "referenceGoodsId": "383382011_SGAMZ-904520356",
          "goodsName": "[3 Boxes] Starbucks Cappuccino Milk Coffee Pods / Coffee Capsules by Nescafe Dolce Gusto",
          "goodsUrl": "https://www.lazada.sg/products/3-boxes-starbucks-cappuccino-milk-coffee-pods-coffee-capsules-by-nescafe-dolce-gusto-i383382011-s904520356.html?clickTrackInfo=undefined&search=1&source=search&spm=a2o42.searchlist.list.3",
          "goodsCategory": "Digital  Goods/Digital  Vouchers/Food  and Beverages",
          "goodsUnitAmount": {
            "currency": "BRL",
            "value": 30000
          },
          "deliveryMethodType": "DIGITAL",
          "goodsQuantity": "10"
        }
      ],
      "shipping": {
        "shippingName": {
          "firstName": "Dehua",
          "lastName": "Liu",
          "fullName": "Dehua Skr Liu",
          "middleName": "Skr"
        },
        "shippingAddress": {
          "zipCode": "310000",
          "address2": "Xihu",
          "city": "Hangzhou",
          "address1": "Wuchang road",
          "state": "Zhejiang",
          "region": "CN"
        },
        "shippingCarrier": "FedEx",
        "shippingPhoneNo": "12345678912",
        "shipToEmail": "test@gmail.com"
      }
    }
  ],
  "buyer": {
    "referenceBuyerId": "test12345678",
    "buyerPhoneNo": "12345678912",
    "buyerEmail": "alipay@alipay.com",
    "buyerName": {
      "firstName": "Dehua",
      "lastName": "Liu",
      "fullName": "Dehua Skr Liu",
      "middleName": "Skr"
    },
    "isAccountVerified": true,
    "successfulOrderCount": 100
  },
  "actualPaymentAmount": {
    "currency": "BRL",
    "value": 29500
  },
  "paymentDetails": [
    {
      "amount": {
        "currency": "BRL",
        "value": "30000"
      },
      "paymentMethod": {
        "paymentMethodType": "CARD",
        "paymentMethodId": "0656XXXXXXX0001",
        "paymentMethodMetaData": {
          "cpf": "02987654320",
          "cardholderName": {
            "firstName": "Tom",
            "lastName": "Jay"
          },
          "expiryMonth": "12",
          "billingAddress": {
            "zipCode": "310000",
            "address2": "Xihu",
            "city": "Hangzhou",
            "address1": "Wuchang road",
            "state": "Zhejiang",
            "region": "CN"
          },
          "expiryYear": "29",
          "cardNo": "4117347806156383"
        }
      }
    }
  ],
  "discountAmount": {
    "currency": "BRL",
    "value": 500
  },
  "env": {
    "terminalType": "APP",
    "clientIp": "112.80.248.78",
    "deviceId": "eYOIkvFpZzztgO0Yu6USdprBQZCWxDhiUAHCiK8K/cH9mT6wMaMOzAKe",
    "osType": "IOS",
    "deviceLanguage": "zh_CN"
  }
}

响应

响应体json
{
  "decision": "ACCEPT",
  "authenticationDecision": "NON_3D",
  "score": 5,
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "reviewed success",
    "resultStatus": "S"
  }
}

结果码

结果码值结果码信息行动建议
SUCCESSS成功。

接口调用成功，无需执行任何操作。

ACCESS_DENIEDF访问被拒绝。

详细原因请联系蚂蚁集团技术支持。

INVALID_APIF调用的接口无效或未激活。

请联系蚂蚁集团技术支持解决问题。

INVALID_CONTRACTF合约中的参数值与当前交易中的参数值不匹配。

检查合约中的参数值是否与当前交易中的参数值匹配。如果匹配，请联系蚂蚁集团 技术支持排查问题。

KEY_NOT_FOUNDF未找到蚂蚁集团或商户的私钥或公钥。

检查私钥或公钥是否存在。如果不存在，请在蚂蚁集团开发者中心上传私钥。

MERCHANT_KYB_NOT_QUALIFIEDF由于商家的 KYB 状态，支付失败。该商户可能不符合 KYB 标准，或者 KYB 状态不符合此交易的条件。

详细原因请联系蚂蚁集团技术支持。

MERCHANT_NOT_REGISTEREDF商户未注册。

请通过注册接口注册商户。如果调用注册接口失败，请联系蚂蚁集团技术支持。

NO_INTERFACE_DEFF接口未定义。

检查 URL 是否正确。请参见接口文档中的端点。

PARAM_ILLEGALF没有传递必传参数，或者存在非法参数。例如，非数字输入、无效日期或参数的长度和类型错误。

检查并验证当前接口所需的请求字段（包括请求头字段和请求体字段）是否正确传递且有效。

SYSTEM_ERRORF发生系统错误。

请勿重试，请联系蚂蚁集团技术支持了解更多详情。

REQUEST_TRAFFIC_EXCEED_LIMITU请求流量超出限制。

再次调用该接口解决问题。若未解决，请联系蚂蚁集团技术支持。

UNKNOWN_EXCEPTIONU接口调用失败，原因未知。

再次调用接口解决问题。如仍未解决，请联系蚂蚁集团技术支持。