AMSPaymentProtocol

2026-06-26 11:26

Note: Translation in progress.

支付或绑卡流程中的回调协议。所有方法均为可选。该协议定义了支付和绑卡生命周期事件的回调方法。所有方法均为可选。欲接收这些回调，请在 AMSPaymentElement.shared 上设置 paymentDelegate 属性。

声明

Objective-C

Swift

copy
@protocol AMSPaymentProtocol <NSObject>

@optional

- (void)onLaunch;
- (void)onReady;
- (void)onEventCallback:(NSString * _Nonnull)eventCode
            eventResult:(AMSEventResult * _Nonnull)eventResult;
- (void)onSizeChanged:(CGFloat)width
               height:(CGFloat)height;
- (void)onBeforeSubmit:(NSDictionary * _Nullable)paymentInfo
            completion:(void (^)(AMSResultInfo * _Nonnull))completion;
- (void)onSubmitPayCallback:(AMSStatusResult * _Nullable)eventResult;

@end

回调方法

onLaunch()

SDK 初始化完成时回调。

Objective-C

Swift

copy
- (void)onLaunch;

onReady()

列表数据渲染完成时回调，且买家可以开始交互。

Objective-C

Swift

copy
- (void)onReady;

onEventCallback()

SDK 内部事件发生时回调。

Objective-C

Swift

copy
- (void)onEventCallback:(NSString * _Nonnull)eventCode
            eventResult:(AMSEventResult * _Nonnull)eventResult;

参数	类型	是否必需	描述
eventCode	String	是	事件码，标识事件类型。
eventResult	AMSEventResult	是	事件结果。

onSizeChanged()

组件尺寸变化时回调。

Objective-C

Swift

copy
- (void)onSizeChanged:(CGFloat)width
               height:(CGFloat)height;

参数	类型	是否必需	描述
width	CGFloat	是	组件新宽度。
height	CGFloat	是	组件新高度。

onBeforeSubmit()

支付提交或绑卡前的自定义处理回调。商户可在此回调中修改支付参数或决定是否继续提交。

Objective-C

Swift

copy
- (void)onBeforeSubmit:(NSDictionary * _Nullable)paymentInfo
            completion:(void (^)(AMSResultInfo * _Nonnull))completion;

参数	类型	是否必需	描述
paymentInfo	[AnyHashable: Any]?	是	待处理的支付或绑卡信息。
completion	(AMSResultInfo) -> Void	是	通过 `AMSResultInfo` 控制支付或绑卡流程（action、scene、data）。

onSubmitPayCallback()

提交支付或绑卡后的结果回调。

Objective-C

Swift

copy
- (void)onSubmitPayCallback:(AMSStatusResult * _Nullable)eventResult;

参数	类型	是否必需	描述
eventResult	AMSStatusResult?	是	提交结果，包含状态码或错误信息。