AlphaPay网关支付接口

AlphaPay网关支付第三方开发者对接文档

QRCode

QRCode - 创建QRCode支付单

QRCode支付单适用于PC端网页/应用进行支付,用户使用微信客户端扫描下单后生成的二维码完成支付。

返回值包括二维码字符串,二维码图片,支付地址,商户可以自行决定直接展示二维码或跳转支付页,跳转支付页需要带上签名信息。 货币类型如果是CNY,注意通过汇率转换后不得低于0.01CAD,否则订单可以创建成功,但支付时会报金额不合法错误

put
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

channel String

支付渠道,大小写敏感

允许值: Alipay, Wechat

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

channel String

支付渠道

partner_code String

商户编码

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

code_url String

支付码字符串,商户可以据此自行生产二维码

qrcode_img String

Base64封装的二维码图片,可直接作为img的src属性

pay_url String

跳转URL

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

QRCode - QRCode支付跳转页

必须先调用创建QRCode订单接口再进行跳转。 建议在用户回调到对应页时通过后台查询订单状态接口确认订单的支付状态。

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}/pay

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求已预先创建

Query Params

字段 类型 描述
redirect String

必填,支付成功后跳转页面,回调时会带上签名参数用于校验

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

JSApi

JSApi - 创建JSAPI订单

JSAPI适用于在微信内打开的网页进行支付,如果用户从公众号进入支付页要求公众号已完成认证。用户下单后跳转至AlphaPay订单页,并拉起微信内置收银台完成支付

返回值包括支付地址,商户应该引导用户跳转支付页,跳转支付页需要带上签名信息; 货币类型如果是CNY,注意通过汇率转换后不得低于0.01CAD,否则订单可以创建成功,但支付时会报金额不合法错误

put
https://pay.alphapay.ca/api/v1.0/jsapi_gateway/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

channel String

支付渠道,大小写敏感

允许值: Alipay, Wechat

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

channel String

支付渠道

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

pay_url String

跳转URL

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

JSApi - 微信JSAPI支付跳转页

必须先调用创建JSAPI订单接口再进行跳转,最终URL以下单api返回的pay_url为准

get
https://pay.alphapay.ca/api/v1.0/wechat_jsapi_gateway/partners/{partner_code}_order_{order_id}

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求已预先创建

Query Params

字段 类型 描述
redirect String

必填,支付成功后跳转页面

directpay Boolean

是否直接支付

默认值: false

允许值: true, false

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

JSApi - 支付宝JSAPI支付跳转页

必须先调用创建JSAPI订单接口再进行跳转,最终URL以下单api返回的pay_url为准

get
https://pay.alphapay.ca/api/v1.0/gateway/alipay/partners/{partner_code}/orders/{order_id}/app_pay

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求已预先创建

Query Params

字段 类型 描述
redirect String

必填,支付成功后跳转页面

directpay Boolean

是否进入页面时立刻支付

默认值: false

允许值: true, false

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

MobileH5

MobileH5 - 创建H5支付单

注意:微信H5支付接口必须单独申请,腾讯批复后方可使用,有需要的商户请联系AlphaPay客服,支付宝无此限制
H5支付适用场景为移动端App或者手机自带浏览器进行支付,用户下单后浏览器跳转至微信支付页面并自动拉起微信/支付宝客户端完成支付。
返回值包括跳转支付地址,跳转支付页需要带上签名信息。 货币类型如果是CNY,注意通过汇率转换后不得低于0.01CAD,否则订单可以创建成功,但支付时会报金额不合法错误



put
https://pay.alphapay.ca/api/v1.0/h5_payment/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

channel String

支付渠道,大小写敏感

允许值: Alipay, Wechat

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

channel String

支付渠道

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

pay_url String

跳转URL

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

MobileH5 - H5支付跳转页

必须先调用创建H5支付订单接口再进行跳转。 建议在用户回调到对应页时通过后台查询订单状态接口确认订单的支付状态。

get
https://pay.alphapay.ca/api/v1.0/h5_payment/partners/{partner_code}/orders/{order_id}/pay

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求已预先创建

Query Params

字段 类型 描述
redirect String

必填,支付成功后跳转页面,回调时会带上签名参数用于校验

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

Miniprogram Payment

Miniprogram_Payment - 创建小程序订单

接入微信小程序需完成海外主体认证,并且认证主体需要与在AlphaPay开通的商户主体一致。具体如何认证请查看微信公众平台相关文档。 用于小程序中发起支付,创建订单后返回小程序支付所需参数,该接口现仅支持微信小程序。 接入参考文档


put
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/microapp_orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

appid String

小程序appid

customer_id String

小程序openid

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

sdk_params String

小程序支付所需参数(Json字符串)

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

RetailPay

RetailPay - 创建线下支付订单

线下支付订单接口用于带有扫码设备的收银终端进行对接,商户输入金额后要求客户出示支付码,用扫码枪扫码后将扫码内容和金额一并提交并完成支付操作。 线下支付订单接口现已兼容微信、支付宝通道

put
https://pay.alphapay.ca/api/v1.0/micropay/partners/{partner_code}/orders/{order_id}

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

device_id String

必填,设备ID

auth_code String

必填,扫描用户微信客户端得到的支付码

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String
  • PAYING:等待支付
  • CREATE_FAIL:订单创建失败
  • CLOSED:已关闭
  • PAY_FAIL:支付失败
  • PAY_SUCCESS:支付成功
order_id String

AlphaPay订单ID,同时也是微信订单ID

partner_order_id String

商户订单ID

total_fee int

订单金额,单位是货币最小面值单位

real_fee int

实际支付金额,单位是货币最小面值单位(目前等于订单金额,为卡券预留)

pay_time String

支付时间(yyyy-MM-dd HH:mm:ss,加拿大西部时间)

create_time String

订单创建时间(最新订单为准)(yyyy-MM-dd HH:mm:ss,加拿大西部时间)

currency String

币种,通常为CAD

channel String

支付渠道 Alipay|支付宝、Wechat|微信

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

AUTHCODEEXPIRE

二维码已过期

NOTENOUGH

余额不足

NOTSUPORTCARD

不支持卡类型

AUTH_CODE_ERROR

二维码被重复提交

AUTH_CODE_INVALID

不是微信支付二维码

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

RetailPay - 创建线下QRCode支付单

线下QRCode支付用于对接无扫码设备的收银终端,下单后得到二维码地址,自行生成二维码图片后展示在收银终端屏幕上,并由用户使用对应支付客户端进行扫码支付。 线下QRCode现已同时兼容支付宝、微信和翼支付客户端进行支付

货币类型如果是CNY,注意通过汇率转换后不得低于0.01CAD,否则订单可以创建成功,但支付时会报金额不合法错误

put
https://pay.alphapay.ca/api/v1.0/retail_qrcode/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

device_id String

必填,设备ID

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

code_url String

支付码字符串,商户可以据此自行生产二维码

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

Alipay Online Payment

Alipay_Online_Payment - 创建支付宝Web订单

用于PC端支付宝支付,创建订单后跳转到返回的pay_url(需附加签名参数和redirect参数),随后进入支付宝支付页面完成支付 该接口仅现仅支持支付宝。

put
https://pay.alphapay.ca/api/v1.0/alipay/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

pay_url String

跳转URL

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

SDKPayment

SDKPayment - 创建SDK订单

用于移动端APP调用微信/支付宝SDK支付,调用API创建订单,得到微信/支付宝SDK调用参数,将参数传递给SDK拉起微信/支付宝支付,并由微信/支付宝客户端直接返回支付结果。 强烈建议获得支付结果后再调用AlphaPay订单查询API确认完成支付后再进行后续流程,避免因超时自动撤单导致资金损失

关于客户端和支付宝整合的更多信息: 支付宝SDK文档

put
https://pay.alphapay.ca/api/v1.0/alipay/partners/{partner_code}/app_orders/{order_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号,要求同一商户唯一

JSON字段

字段 类型 描述
description String

必填,订单标题(最大长度128字符,超出自动截取)

price int

必填,金额,单位为货币最小单位,例如使用100表示CAD1.00

currency String

币种代码

默认值: CAD

允许值: CAD, CNY

channel String

支付渠道,必填,大小写敏感

允许值: Alipay, Wechat

notify_url String

支付通知url,详见支付通知api,不填则不会推送支付通知

operator String

操作人员标识

system String

客户端操作系统类型,可选参数

允许值: android, iphone, ipad

version String

客户端版本号,可选参数

appid String

微信 appid,微信通道要求必填(支付宝则不需要)

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String

SUCCESS表示创建订单成功,EXISTS表示订单已存在

partner_code String

商户编码

full_name String

商户注册全名

partner_name String

商户名称

order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

sdk_params String

调用SDK的参数字符串

错误码

名称 描述
ORDER_MISMATCH

订单号与商户不匹配

ORDER_PAID

订单已支付

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

CommonApi

CommonApi - 获取当前汇率

获取当前微信CAD兑CNY汇率值(1CAD=?CNY),该汇率仅做参考,以实际成交汇率为准

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/channel_exchange_rate

Header

字段 描述
Accept

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

wechat_rate Double

微信汇率

alipay_retail_rate Double

支付宝线下渠道汇率

alipay_online_rate Double

支付宝线上渠道汇率

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

错误码

名称 描述
SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

CommonApi - 查询订单状态

查询范围包括QRCode订单、JSAPI订单和线下支付订单

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}

Header

字段 描述
Accept

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String
  • PAYING:等待支付
  • CREATE_FAIL:订单创建失败
  • CLOSED:已关闭
  • PAY_FAIL:支付失败
  • PAY_SUCCESS:支付成功
如果需要可以用相同订单号再次发起支付单,支付成功或支付中的无法重复发起订单
order_id String

AlphaPay订单ID,同时也是微信订单ID,最终支付成功的订单ID可能不同

partner_order_id String

商户订单ID

total_fee int

订单金额,单位是货币最小面值单位

real_fee int

实际支付金额,单位是货币最小面值单位(目前等于订单金额,为卡券预留)

rate Double

交易时使用的汇率,1CAD=?CNY

pay_time String

支付时间(yyyy-MM-dd HH:mm:ss,加拿大西部时间)

create_time String

订单创建时间(最新订单为准)(yyyy-MM-dd HH:mm:ss,加拿大西部时间)

currency String

币种,通常为CAD

channel String

支付渠道 Alipay|支付宝、Wechat|微信

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

CommonApi - 申请退款

一笔支付订单可以分多次退款,退款总金额不得超过实际支付金额,退款币种与支付订单一致

put
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}/refunds/{refund_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号

refund_id String

必填,商户退款单号

JSON字段

字段 类型 描述
fee int

必填,退款金额,单位是货币最小单位,单个订单退款单金额总和不能超过用户支付金额

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String
  • WAITING:正在提交
  • CREATE_FAILED:提交失败
  • SUCCESS:提交成功
  • FAILED:退款失败
  • FINISHED:退款成功
  • CHANGE:退款无法到账,需要人工介入
refund_id String

AlphaPay退款单号

partner_refund_id String

商户提交的退款单号

amount int

退款金额,单位是货币最小单位

currency String

币种,通常为CAD

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

ORDER_NOT_PAID

订单未支付完成,无法退款

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

CommonApi - 查询退款状态

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders/{order_id}/refunds/{refund_id}

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

order_id String

必填,商户支付订单号

refund_id String

必填,商户退款单号

Query Params

字段 类型 描述
time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

Success 200

字段 类型 描述
return_code String

执行结果

result_code String
  • WAITING:正在提交
  • CREATE_FAILED:提交失败
  • SUCCESS:提交成功
  • FAILED:退款失败
  • FINISHED:退款成功
  • CHANGE:退款无法到账,需要人工介入
refund_id String

AlphaPay退款单号

partner_refund_id String

商户提交的退款单号

amount int

退款金额,单位是货币最小单位

currency String

币种,通常为CAD

错误码

名称 描述
ORDER_NOT_EXIST

订单不存在

ORDER_MISMATCH

订单号与商户不匹配

ORDER_NOT_PAID

订单未支付完成,无法退款

REFUND_NOT_EXIST

退款单不存在

REFUND_MISMATCH

退款单号与支付单不匹配

SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

CommonApi - 查看账单

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/orders

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

Query Params

字段 类型 描述
date String

订单创建日期,'yyyyMMdd'格式,加拿大西部时间,不填默认查询所有订单

status String

订单状态

  • ALL:全部订单,包括未完成订单和已关闭订单
  • PAID:只列出支付过的订单,包括存在退款订单
  • REFUNDED:只列出存在退款订单

默认值: ALL

允许值: 'ALL', 'PAID', 'REFUNDED'

page int

页码,从1开始计算

默认值: 1

limit int

每页条数

默认值: 10

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

ROOT

字段 类型 描述
return_code String

执行结果

data JSON[]

订单列表

pagination JSON

分页信息

analysis JSON

统计信息

data

字段 类型 描述
order_id String

AlphaPay订单ID

partner_order_id String

商户订单ID

total_fee int

订单金额,单位是货币最小单位

real_fee int

订单支付金额,单位是货币最小单位

channel String

支付渠道 Alipay|支付宝、Wechat|微信

currency String

币种

create_time String

格式'yyyy-MM-dd HH:mm:ss',加拿大西部时间,订单创建时间

pay_time String

格式'yyyy-MM-dd HH:mm:ss',加拿大西部时间,支付时间,未支付订单为空

status String

订单状态

  • SUBMITTING:提交中
  • SUBMIT_FAIL:提交失败
  • WAITING_PAYMENT:等待支付
  • CLOSED:已关闭
  • PAYMENT_FAIL:支付失败
  • SUCCESS:支付成功
order_body String

订单标题

gateway String

订单模式

  • Retail In-Store:AlphaPay官方POS线下支付
  • QRCODE:商户静态二维码
  • Online API:网站QRCode API支付
  • WeChat HTML5:JSAPI支付
  • Retail API:线下API支付
  • Mobile H5:H5 API支付
partner_code String

商户编码

partner_name String

商户名称

refund_fee String

当前订单退款金额,货币最小单位

pagination

字段 类型 描述
page int

页码

limit int

每页条数

totalCount int

总条数

totalPages int

总页数

analysis

字段 类型 描述
order_count int

支付成功订单数(包含有退款订单)

total_fee int

成交订单总额,货币最小单位

real_fee int

支付总额,货币最小单位

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

错误码

名称 描述
SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

CommonApi - 查看账单流水

本接口将列出商户当日所有流水,包括所有接口(含非网关接口)支付通道的付款、AlphaPay优惠补贴、退款、 退款失败补正、系统补正、营销账户转入转出等,不含清算信息
注意一笔付款订单或退款订单均可能对应多条流水记录

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/transactions

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

Query Params

字段 类型 描述
date String

必填, 账单日期,'yyyyMMdd'格式,加拿大西部时间

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

ROOT

字段 类型 描述
return_code String

执行结果

result_code String

业务执行结果

transaction_count int

流水总条目

order_count int

付款单数

refund_count int

退款单数

transactions JSON[]

流水列表

transactions

字段 类型 描述
transaction_time String

交易时间,格式yyyyMMddHHmmss,加拿大西部时间

order_id String

AlphaPay订单ID

partner_order_id String

商户订单ID

channel_order_id String

渠道方(Alipay/Wechat)订单号

refund_id String

AlphaPay退款单ID(仅退款或退款失败补正)

partner_refund_id String

商户系统提交退款ID(仅退款或退款失败补正)

gateway String

下单接口

  • 0: AlphaPay POS机付款码(扫描客户展示的付款码)
  • 1: AlphaPay POS机聚合支付码(客户扫描POS展示的二维码)
  • 2: AlphaPay 商户静态码
  • 3: QRCode 网关
  • 4: JSAPI 网关
  • 5: 第三方POS付款码网关
  • 6: 第三方POS聚合支付码网关
  • 7: AlphaPay 商户静态码(已停用)
  • 8: H5网关
channel String

支付渠道 Alipay|支付宝、Wechat|微信

type String

流水类型

  • Credit: 入账
  • Debit: 出账
currency String

币种

total_amount int

订单总金额,单位是货币最小单位

input_amount int

订单输入金额,单位是货币最小单位

customer_payment_amount int

用户实际支付金额,单位是货币最小单位

settle_amount int

结算金额,币种为CAD,单位是货币最小单位

exchange_rate double

使用汇率

remark String

备注

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

错误码

名称 描述
SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

CommonApi - 查看清算详情

本接口将列出商户当日清算的所有流水,包括所有接口(含非网关接口)支付通道的付款、AlphaPay优惠补贴、退款、 退款失败补正、系统补正、营销账户转入转出等
注意一笔付款订单或退款订单均可能对应多条流水记录

get
https://pay.alphapay.ca/api/v1.0/gateway/partners/{partner_code}/settlements

Header

字段 描述
Accept

application/json

Content-Type

application/json

Path Variable

字段 类型 描述
partner_code String

必填,商户编码,由4位大写字母或数字构成

Query Params

字段 类型 描述
date String

必填, 清算日期,'yyyyMMdd'格式,加拿大西部时间

time Long

必填,UTC毫秒时间戳

nonce_str String

必填,随机字符串

sign String

必填,签名

ROOT

字段 类型 描述
return_code String

执行结果

result_code String

业务执行结果

settle_from String

订单起始日期,yyyyMMdd

settle_to String

订单截止日期,yyyyMMdd

settle_days String

清算周期(T+n)

transaction_count int

流水总条目

order_count int

付款单数

refund_count int

退款单数

total_credit int

入账总金额(CAD分)

total_debit int

支出总金额(CAD分)

total_surcharge int

手续费总额(CAD分)

total_transfer int

打款总额(CAD分)

transactions JSON[]

流水列表

transactions

字段 类型 描述
transaction_time String

交易时间,格式yyyyMMddHHmmss,加拿大西部时间

order_id String

AlphaPay订单ID

partner_order_id String

商户订单ID

channel_order_id String

渠道方(Alipay/Wechat)订单号

refund_id String

AlphaPay退款单ID(仅退款或退款失败补正)

partner_refund_id String

商户系统提交退款ID(仅退款或退款失败补正)

gateway String

下单接口

  • 0: AlphaPay POS机付款码(扫描客户展示的付款码)
  • 1: AlphaPay POS机聚合支付码(客户扫描POS展示的二维码)
  • 2: AlphaPay 商户静态码
  • 3: QRCode 网关
  • 4: JSAPI 网关
  • 5: 第三方POS付款码网关
  • 6: 第三方POS聚合支付码网关
  • 7: AlphaPay 商户静态码(已停用)
  • 8: H5网关
channel String

支付渠道 Alipay|支付宝、Wechat|微信

type String

流水类型

  • Credit: 入账
  • Debit: 出账
currency String

币种

total_amount int

订单总金额,单位是货币最小单位

input_amount int

订单输入金额,单位是货币最小单位

customer_payment_amount int

用户实际支付金额,单位是货币最小单位

settle_amount int

结算金额,单位是CAD分

surcharge_rate String

手续费费率(x%)

surcharge int

手续费金额,单位是CAD分

transfer_amount int

打款金额,单位是CAD分

exchange_rate double

使用汇率

remark String

备注

ERROR

名称 描述
return_code

Error Code

return_msg

Error Description

错误码

名称 描述
SYSTEMERROR

系统内部异常

INVALID_SHORT_ID

商户编码不合法或没有对应商户

SIGN_TIMEOUT

签名超时,time字段与服务器时间相差超过5分钟

INVALID_SIGN

签名错误

PARAM_INVALID

参数不符合要求,具体细节可参考return_msg字段

NOT_PERMITTED

未开通网关支付权限

INVALID_CHANNEL

不合法的支付渠道名称,请检查大小写

CommonApi - 付款通知

若订单创建时提供了notify_url,系统会在用户支付成功后向这个地址主动发送支付成功状态推送,请求方式为POST 与服务器API不同,推送校验参数会包含在json内,商户系统应该验证校验参数,确定来源正确后再进行后续操作。 商户系统收到请求后应按要求返回参数,若AlphaPay未收到合法参数,视为商户未接收成功,推送动作最多会重试3次,商户系统应当能够处理收到的重复请求。

post
https://pay.alphapay.ca//notify_url

Header

字段 描述
Accept

application/json

Content-Type

application/json

JSON字段

字段 类型 描述
time long

UTC时间戳

nonce_str String

随机字符串

sign String

签名

partner_order_id String

商户订单ID

order_id String

AlphaPay订单ID

total_fee int

订单金额,单位是最小货币单位

real_fee int

支付金额,单位是最小货币单位

rate Double

交易时使用的汇率,1CAD=?CNY

currency String

币种,CAD

channel String

支付渠道 Alipay|支付宝、Wechat|微信

create_time String

订单创建时间,格式为'yyyy-MM-dd HH:mm:ss',加拿大西部时间

pay_time String

订单支付时间,格式为'yyyy-MM-dd HH:mm:ss',加拿大西部时间

Success 200

字段 类型 描述
return_code String

SUCCESS