授权结果通知

2024-11-22 00:47

当授权成功或授权取消成功时，Antom 会使用此接口将授权结果发送给您。

结构

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

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

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

入参

authorizationNotifyType String REQUIRED

授权通知类型。有效值包括：

AUTHCODE_CREATED（仅限代扣）：表示用户同意授权代扣。用户同意授权后，可以从此通知中获取支付方式生成的授权码，并在 申请支付令牌 接口中使用该授权码以获取访问令牌。
TOKEN_CREATED（仅限快捷支付）：表示用户在商户客户端成功发起快捷支付的授权。
TOKEN_CANCELED：表示由商户或支付方式客户端发起的授权取消操作成功。

更多信息：

最大长度：32 字符

authClientId String

用户授予二级商户的专属 ID，以用于资源访问权限。该值由收单机构指定，并需要在 Antom 上注册。

注意：
此字段在 Alipay+ 支付方式发起 授权咨询 接口时返回。
在 Alipay+ 支付方式中，此字段的值与 支付（收银台）接口中的 referenceMerchantId 值相同。

更多信息：

最大长度：64 字符

accessToken String

用于访问相应用户资源范围的访问令牌。

注意：当 authorizationNotifyType 的值为TOKEN_CANCELED 或TOKEN_CREATED 时，此字段返回。

更多信息：

最大长度：128 字符

authState String

由收单机构生成的字符串，用于表示咨询请求。该字段的值用于验证是否与 授权咨询 请求中指定的 authState 值一致。

注意：当 authorizationNotifyType 为 AUTHCODE_CREATED 和 TOKEN_CREATED 时，此字段返回。

更多信息：

最大长度：256 字符

authCode String

用于获取访问令牌的授权码。当用户跳转到由支付方式返回的重构后的跳转链接后，应用程序将从中获取该值。

注意: 当 authorizationNotifyType 为 AUTHCODE_CREATED 时，此字段返回。

更多信息：

最大长度：64 字符

reason String

授权被取消的原因。当用户提供了取消授权的理由时，此字段会发送给商户。

注意: 当 authorizationNotifyType 为 TOKEN_CANCELED 时，此字段返回。

更多信息：

最大长度：256 字符

result Result REQUIRED

授权结果。Antom 只在授权成功或取消授权成功时返回授权通知。因此，只提供成功的授权结果。

Show child parameters

userLoginId String

用户在支付方式中注册时使用的登录 ID 。登录 ID 可以是用户的电子邮件地址或电话号码。

注意：如果您不想让用户每次登录时都手动输入 ID ，请传入此参数。

更多信息：

最大长度：64 字符

userId String

由支付方式提供者生成的用于标识用户的 ID。

更多信息：

最大长度：64 字符

出参

result Result REQUIRED

您需要发送给 Antom 的一个固定值，以确认已收到通知。

Show child parameters

API Explorer

请求

Case

A canceled authorization result

请求体

响应

响应体

结果处理逻辑

在收到 Antom 通知后，发送以下固定值的消息给 Antom，以确认收到 Antom 的通知：

Sample Code

如果由于操作问题或网络问题没有将此类消息返回给 Antom，Antom 会反复发送通知，直到商家返回所需消息。首次通知发送后的 24 小时内会进行重试。通知将重试最多八次，间隔为 0 秒, 2 分钟, 10 分钟, 10 分钟, 1 小时, 2 小时, 6 小时, 和 15 小时。

注意：沙箱环境中，如果您没有按照固定格式返回信息，Antom 将不会重新发送异步通知给您。