Antom, leading provider of tailored payment solutions

notifyPayment

在支付处理完成时,APO 使用此接口将支付结果发送给商户。商户根据支付结果完成商户端的后续交易。 

结构

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

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

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


入参

notifyType String  REQUIRED

支付状态通知类型。有效值为固定为 PAYMENT_RESULT,表示通知为支付结果。

result Result  REQUIRED

支付结果。

Show child parameters

paymentRequestId String  REQUIRED

商家为识别支付请求分配的专属 ID。

更多信息:

  • 最大长度:64 字符

paymentId String  REQUIRED

Antom 为识别支付而分配的支付 ID。paymentId 与 paymentRequestId 之间存在一一对应关系。

更多信息:

  • 最大长度:64 字符

paymentAmount Amount  REQUIRED

商户请求在订单币种中接收的支付金额。

Show child parameters

paymentCreateTime Datetime  

支付创建的日期和时间。

更多信息:

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

paymentTime Datetime  

支付达到最终成功或失败状态的日期和时间。

更多信息:

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

pspCustomerInfo PspCustomerInfo  

电子钱包的客户信息。

注意:当电子钱包能够提供相关信息时,此字段将返回。

Show child parameters

grossSettlementAmount Amount  

结算总额,等于交易金额乘以 settlementQuote 的值。

注意:当结算币种与交易币种相同时,此字段为空。

Show child parameters

settlementQuote Quote  

交易时结算币种与交易币种之间的汇率,仅在锁定汇率的情况下提供。

注意:当结算币种与交易币种相同时,此字段为空。

Show child parameters

receiptInfo ReceiptInfo  

收据信息。

注意:此参数在线下卡支付场景下必传。

Show child parameters

acquirerInfo AcquirerInfo  

收单机构侧信息。

注意:此参数在线下卡支付场景下必传。

Show child parameters

acquirerReferenceNo String  

收单机构侧交易流水号。

注意:当交易由非 Antom 收单机构结算时,请指定此参数。

更多信息:

  • 最大长度:64 字符

actualPaymentAmount Amount  REQUIRED

实际支付金额。

Show child parameters

cardInfo CardInfo  

买家支付的卡信息。

注意:针对指定地区的特定商户,当在 createPaymentSession 接口中的 paymentMethodType 值为 CARD 时,返回此参数。

Show child parameters

paymentResultInfo PaymentResultInfo  

支付结果信息。

注意:针对指定地区的特定商户,当在 createPaymentSession 接口中的 paymentMethodType 值为 CARD 时,返回此参数。

Show child parameters

出参

result Result  REQUIRED

发送给 APO 以确认收到通知的固定值。

Show child parameters
API Explorer

请求

请求体

响应

响应体

更多信息 

本节提供了关于关键参数的额外信息。请参阅以下参数以了解详情:

  • result(在由 Antom 发送的通知请求中):  
    支付结果。 如果 result.resultStatus 的值为 S,则支付成功。
  • paymentTime:
    只有当 result.resultStatus 的值为 S 时,此字段才会返回。 

结果处理逻辑

如果 result.resultStatus 的值为 S,支付结果通知成功。 Antom 不会采取进一步行动。

结果码

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

支付成功,无需进一步操作。

PROCESS_FAILF发生了常见的业务失败。

获取 Antom 技术支持前请勿尝试。

USER_KYC_NOT_QUALIFIEDF由于用户的 KYC 状态,支付失败。用户要么未完成 KYC,要么 KYC 状态不满足此交易要求(例如,支付金额或产品信息的限制)。

首先完成 KYC 验证。