Skip to main content
POST
预授权

Authorizations

signature
string
header
required

Example: MIIEpQIBAAKCAQEA...(Base64编码的签名字符串)

加签

加签是开放平台和商户对于交互消息完整性的校验。加签行为主要发生两个部分:

  1. 商户服务器端针对向PayAllGlobal开放平台发送的请求报文进行加签;
  2. PayAllGlobal开放平台针对通知商户的异步消息进行加签。 PayAllGlobal平台要求使用 RSA 私钥进行加签, 使用 RSA 公钥进行验签。 因此,在以上两部分描述的交互中, 存在商户公私钥、PayAllGlobal 公私钥,开发者需要使用商户私钥,对第一部分报文进行加签,使用 PayAllGlobal 公钥对第二部分消息进行验签。

加签规则如下:

使用商户私钥对请求体进行 SHA256withRSA 签名后,再进行 Base64 编码的结果。

  1. 使用 商户私钥对待 request.body 进行签名(SHA256WithRSA 计算原始数据的SHA-256哈希值。 使用私钥对哈希值进行签名,即使用私钥对哈希值进行RSA加密。此时得到的加密结果就是数字签名。);
  1. 将加签内容进行 Base64 编码;
  1. 将编码后的内容放在请求头部 signature 参数中。 注意,加签是对 request.body 进行签名,当查询等 request.body 为空时,则无需加签。

Body

application/json
charset
string
default:UTF-8
required

交互数据的编码【utf-8】

Example:

"UTF-8"

version
string
required

接口版本,当前版本为【2.0.0】,目前只能传2.0.0,不能不传

Example:

"2.0.0"

transType
enum<string>
default:PAY
required

交易类型

Available options:
PAY: 消费支付,
CREDIT_CARD: 信用卡支付,
3D_PREAUTH_VOIDS: 3D 预授权撤销,
3D_PREAUTH_COMPLETION: 3D 预授权完成,
REFUND: 退款,
VOIDS: 撤销,
QUERY: 查询,
TRANSFER: 转账,
DOWNLOAD: 文件下载,
REGISTRATION: 商户注册,
FILEUPLOAD: 文件上传,
INQUIRYREGISTRATIONSTATUS: 查询注册状态,
AUTHORIZE: 授权,
CASHIER_PAY: 收银台支付
accessType
string
default:s2s
required

接口接入类型,固定为服务端到服务端(s2s)模式

Example:

"s2s"

signType
string
default:RSA
required

报文签名类型,当前支持RSA。

Example:

"RSA"

memberId
string
required

机构号,商户侧唯一标识

Example:

"2023010558663764"

merchantId
string
required

商户号,商户唯一标识

Example:

"2023010558663764"

transChannel
enum<string>
required

支付渠道

Available options:
WEIXIN,
UNIONPAY,
ALIPAY_CN,
ALIPAY_HK,
GCASH,
BPI,
TNG,
BOOST,
DANA,
KAKAOPAY,
TRUEMONEY,
BRAZIL_PIX,
Ewallet_PicPay,
Khipu,
RABBIT_LINE_PAY,
ALIPAY_INSTORE,
NAVERPAY,
TOSSPAY,
MAYA,
BILLEASE,
GoPay,
OVO,
DOKU,
Dragonpay,
Konbini,
PayEasy,
GrabPay,
PAYCO,
MPAY,
PROMPT_PAY,
HIPAY,
TINABA,
KREDIVO_ID,
AKULAKU_PAYLATER,
KPLUS,
QRPH,
BANK_TRANSFER,
KOREAN_CARDS
currency
string
required

订单币种ISO4217币种的字母码 eg. USD, CNY, EUR

Example:

"USD"

transAmt
string
required

订单金额 请按照4217币种的最小单位传递 eg.(CNY) 110.86 (JPY) 1110

Example:

"20.01"

merchantOrderId
string
required

商户订单号

Example:

"20230424141154"

payMode
enum<string>
default:QRCODE
required

交易类型 更多描述参考 支付方式 [blocked]

Available options:
QRCODE,
MICROPAY,
JSAPI,
MINIPROGRAM,
APP,
H5,
3D,
FIXEDCODE
Example:

"QRCODE"

merchantOrderTime
string<date-time>
required

商户订单时间

merchantRegion
string
required

商户所在地区

Example:

"US"

threeDsType
string

使用3d交易必传(示例值 1.0 2.0)

Example:

"2.0"

deviceChannel
string

设备渠道

transTimeout
string

订单有效时长(整数格式 单位:分钟)

carrierId
string

发生交易的网站域名或者APP名称

Example:

"carrierId"

goodsName
string

商品名称,多个商品 用";"隔开

Example:

"Iphone15"

dcc
string

交易是否走DCC 传送:dcc

Example:

"DCC"

notifyUrl
string<uri>

异步通知地址

Required string length: 10 - 200
redirectUrl
string

前台回调地址

Example:

"http://www.gogole.com"

customerIp
string

用户ip

Example:

"18.277.26.154"

payMethodInfo
object
osType
string

手机操作系统类型(支付类型为APP时必传)

Example:

"IOS"

authCode
string

授权码(支付渠道为WEIXIN且支付类型为MICROPAY时需传值)

Example:

"133788758877188822"

appId
string

公众账号ID

Example:

"wxd678efh567hg6787"

openId
string

应用内用户ID

Example:

"oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"

reqReserved
string

商户扩展字段

Example:

"reqReserved"

reserved
string

保留字段

Example:

"reserved"

buyerId
string

商户用户ID(支付渠道为BRAZIL_PIX必传)

Example:

"oUpF8uMuAJO_M2pxb1Q9zNjWeS6o"

address
object
customer
object
subMerchantId
string
userAgent
string
goods
object[]
store
Store · object
browserInfo
object

Response

200 - application/json

OK

isSuccess
boolean
required

是否成功,true表示成功,false表示失败

Example:

true

errCode
string
required

响应状态码,errCode为00000000表示响应成功,其他状态码表示响应失败。具体系统错误码可以参考系统错误码。

Example:

"00000003"

errMessage
string
required

错误消息

Example:

"处理中"

status
string
required

订单状态(见补充说明)

Examples:

"PENDING:处理中"

"SUCCESS:成功"

"FAIL:失败"

traceId
string
required

请求消息唯一标识。traceId为本次调用产生的流水号,接口调用异常,可以提供此流水号用于排查问题。

Example:

"33fae7b7aed1233f"

data
object