Antom, leading provider of tailored payment solutions

notifyCapture

APO 使用此接口在请款处理完成后,将请款结果通知给您。

结构

报文由报文头和报文体组成。本文主要介绍报文体结构信息,有关报文头的结构信息,请参阅:
注意:将每个字段(除数组外)的数据类型设置为字符串。这意味字段值必须使用双引号(" ")括起来。例如:
  • 如果字段的数据类型为整数属性,且其值为 20,设置为 "20"。
  • 如果字段的数据类型为布尔属性,且其值为 true,设置为 "true"。

入参

result Result  REQUIRED

请款结果的详细信息,如请款状态、结果代码和结果消息。 

notifyType String  REQUIRED

通知的类型。此接口的通知类型为CAPTURE_RESULT。 

captureRequestId String  REQUIRED

商户为识别请款请求而分配的专属 ID。

更多信息:

  • 最大长度:64 字符

paymentId String  REQUIRED

APO 为识别支付而分配的支付 ID。 

更多信息:

  • 最大长度:64 字符

captureId String  REQUIRED

APO 为识别请款而分配的请款 ID。 

更多信息:

  • 最大长度:64 字符

captureAmount Amount  REQUIRED

商家在交易币种中请求收取的请款金额。

captureTime Datetime  

APO 完成请款的时间。

acquirerInfo AcquirerInfo  

处理该支付的收单机构信息。

出参

result Result  REQUIRED

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

请求

Case
json
{
  "captureAmount": {
    "currency": "BRL",
    "value": "50000"
  },
  "captureId": "2022XXXXXXX",
  "captureRequestId": "Merchant_Request_ID_XXXXXX",
  "captureTime": "2022-11-10T00:34:52-08:00",
  "notifyType": "CAPTURE_RESULT",
  "paymentId": "2022XXXXXXX",
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "success.",
    "resultStatus": "S"
  }
}

响应

json
{
  "result": {
    "resultCode": "SUCCESS",
    "resultMessage": "Success",
    "resultStatus": "S"
  }
}

结果码

结果码值结果码信息行动建议
SUCCESSS成功
请款成功,无需进一步操作。  
ACCESS_DENIEDF访问被拒绝。
请联系 APO 技术支持获取详细原因。  
AUTH_CANCELLEDF支付授权已取消。
使用新的 paymentRequestId 来发起支付。
AUTH_EXPIREDF支付授权已过期。
使用新的 paymentRequestId 来发起支付。
AUTH_NOT_FOUNDF找不到支付授权。
请联系 APO 技术支持获取详细原因。  
CAPTURE_AMOUNT_EXCEED_AUTH_LIMITF请款总额超过了授权支付金额的限制。
使用不超过授权支付金额的金额创建新的请款请求,或联系 APO 技术支持。 
CAPTURE_IN_PROCESSU请款处理中。
等待 APO 的通知或查询请款结果。  
CURRENCY_NOT_SUPPORTF币种不受支持。
检查请求中使用的币种,例如请款币种。如果问题仍然存在请联系 APO 技术支持获取详细原因。  
INVALID_CONTRACTF合同中的参数值与当前交易不符。
检查合同中的参数值是否与当前交易匹配。如果值匹配,请联系 APO 技术支持解决问题。  
MULTI_CAPTURE_NOT_SUPPORTEDF交易不支持多次请款。
请联系 APO 技术支持获取详细原因。  
NO_PAY_OPTIONSF没有可用的支付方式。
请联系 APO 技术支持以获取详细原因。
ORDER_IS_CANCELEDF交易已取消。
使用新的 paymentRequestId 发起支付。  
ORDER_STATUS_INVALIDF交易状态异常,无法进行支付请款。
检查交易状态。如果值匹配,请联系 APO 技术支持解决问题。  
PARAM_ILLEGALF缺少必需的参数,或者存在非法参数。例如,非数字输入,无效的日期,或者参数的长度和类型错误。
检查并验证当前接口所需的请求字段(包括头部字段和正文字段)是否正确传递并有效。
PAYMENT_COUNT_EXCEED_LIMITF请款次数超过了支付方式指定的限制。
请联系 APO 技术支持了解具体限制。
PROCESS_FAILF请款失败。
在获取 APO 技术支持前请勿重试。
REPEAT_REQ_INCONSISTENTF提交的请求已存在,且此请求的参数值与已存在请求不一致。
确保请求中的所有字段相同,或使用新的 paymentRequestId 发起支付。
RISK_REJECTF因风险控制,请求被拒绝。
提示买家请求因风险控制失败而被拒绝。 
USER_AMOUNT_EXCEED_LIMITF请款金额超过了买家的支付限额。
使用不超过买家支付限额的金额创建新的请款,或联系,买家或发卡行。
USER_BALANCE_NOT_ENOUGHF用户的余额不足以完成请款。
请联系 APO 技术支持获取详细原因。  
USER_NOT_EXISTF在支付方式端,买家的账户不存在。
请联系买家或发卡行。
USER_STATUS_ABNORMALF在支付方式端,买家的账户状态异常。
请联系 APO 技术支持了解具体原因。
UNKNOWN_EXCEPTIONU由于未知原因,接口调用失败。
再次调用接口解决问题。如果问题持续,请联系 APO 技术支持。