Alipay Direct 文档
POST
/api时序图
sequenceDiagram
Customer->>Merchant: 点击支付
Merchant->>UseePay Server: 调用/api接口
UseePay Server->>Merchant: Response[resultCode=pending]
Merchant->>Customer: 展示response[redirectUrl]
Customer->>Alipay Server: 进行支付
Alipay Server ->> UseePay Server: 同步通知支付结果
Alipay Server -->> UseePay Server: 异步支付结果
UseePay Server->>Merchant: 展示支付结果
Merchant->>Customer: 展示支付结果通知请求支付时传输的redirectUrl页面
UseePay Server-->>Merchant: 异步通知notifyUrl接口
Request 请求参数说明
PayerInfo Object
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
paymentMethod | Y | String | alipay |
osType | Y | String | terminalType为WAP的时候必传IOS/ANDROID |
terminalType | Y | String | WEB/WAP |
UserInfo Object
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
userId | N | string | max=128 用户id |
ip | Y | string | max=128 IPv4或IPv6 |
N | string | max=128用户邮箱 | |
phoneNo | N | string | max=32 用户手机号 |
OrderInfo Object
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
subject | Y | String(128) | 订单标题,可以是商品名称 |
goodsInfo | N | Array Json String (4096) | 商品信息, 请参考 goodsInfo |
goodsInfo
参数 | 必选 | 类型 | 说明 |
---|---|---|---|
name | Y | String | 商品名 |
body | Y | String | 商品描述 |
quantity | Y | number | 商品数量 |
price | Y | String | 商品价格,必须大于0,单位为对应货币的最小货币单位参考货币单位一节 |
url | N | String | 商品链接 |
image | N | String | 商品图片 |
请求参数
Header 参数
Content-Type
string
必需
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
transactionType
string
交易类型: pay
示例值:
pay
version
string
必需
目前固定为1.0(5)
示例值:
1.0
signType
string
必需
商户生成签名字符串所使用的签名算法类型,目前支持:RSA/MD5
示例值:
MD5
merchantNo
string
商户号
示例值:
500000000007362
transactionId
string
商户订单号
示例值:
202212070142347
transactionExpirationTime
string
可选
单位分钟,不能超过10分钟
示例值:
10
appId
string
网站域名
示例值:
www.pay.com
redirectUrl
string
跳转商户地址
示例值:
https://gatewaytest.useepay.com/gateway-test/redirectV2u0
notifyUrl
string
异步通知
示例值:
https://gatewaytest.useepay.com/gateway-test/notifyV2u0
echoParam
string
可选
回声参数,响应报文会原样返回
示例值:
echoParam
payerInfo
string
付款方信息
示例值:
{ "paymentMethod": "alipay", "osType": "terminalType为WAP的时候必传IOS/ANDROID" , "terminalType": "WEB/WAP"}
orderInfo
string
订单信息
示例值:
{"subject":"order title","goodsInfo":[{"id":"商品编号","name":"商品名称","body":"商品描述","category":"商品类目","categoryTree":"商品类目树,不同级别类目使用”|”分割","brand":"商品品牌","quantity":1,"price":1234,"url":"商品url","sku":"商品sku","image":"商品图片url"}],"shippingAddress":{"email":"haile1y@useepay.com","phoneNo":"123123","firstName":"Victor","lastName":"Yang","street":"Heathcoat House, 20 Savile Row","postalCode":"W1S 3PR","city":"London","state":"LND","country":"GB"}}
userInfo
string
消费者信息
示例值:
{ "userId": "victor007", "ip": "103.25.65.178", "email": "victor.yang@useepay.com", "phoneNo": "(323) 585-4433" }
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
amount
string
必需
支付金额,单位为对应币种的最小货币单位(详见 ISO 4217)(12)
redirectUrl
string
必需
当resultCode=pending时存在
resultCode
string
业务结果码
判断交易是否成功 received 表示收银台请求被成功接受,可以返回redirectUrl给消费者
sign
string
必需
errorCode
string
错误返回码
用于展示给消费者具体的错误信息,可参考错误码页面
transactionId
string
必需
max=64 商户订单号,建议每次请求的 transactionId 唯一,有利于后续订单查询和对账。
errorMsg
string
错误返回信息
用于展示给消费者具体的错误信息,可参考错误码页面
transactionType
string
必需
reference
string
必需
signType
string
签名类型
currency
string
必需
max=3 位 ISO 大写字母货币代码(详见 ISO 4217) 目前仅支持JPY
merchantNo
string
必需
示例
成功示例
{
"amount": "200",
"redirectUrl": "https://open-sea-global.alipayplus.com/api/open/v1/ac/cashier/self/codevalue/checkout.htm?codeValue=281666040092tD2Y2sw7o9hJuk8Yef7v47tt&loadMode=2",
"resultCode": "pending",
"sign": "7e7ff13816c134645797fd23a4d5d190",
"errorCode": "3200",
"transactionId": "Al022305180025118",
"errorMsg": "Transaction is pending",
"transactionType": "pay",
"reference": "1012305180025688429",
"signType": "MD5",
"currency": "CNY",
"merchantNo": "500000000009545"
}
最后修改时间: 1 年前