支付宝☍
版本:v1
认证方式:Bearer Token
目录☍
接口列表☍
创建订单 - 当面付☍
接口说明
创建一个当面付订单,并返回支付二维码。
基本信息☍
- 接口名称:创建订单 - 当面付
- 请求方式:POST
- 请求路径:/Alipay/{appKey}/CreateOrder
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
orderNo | string | - | 自定义订单号 | 是 |
amount | number | - | 订单金额。例如:0.01 | 是 |
subject | string | - | 商品名称 | 是 |
returnUrl | string | - | 支付完成后返回的URL地址 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | string | 响应数据 | 否 |
error | string | 错误信息 | 否 |
创建订单 - PC支付☍
接口说明
创建一个PC支付订单,并返回支付页面。
基本信息☍
- 接口名称:创建订单 - PC支付
- 请求方式:POST
- 请求路径:/Alipay/{appKey}/CreateOrderPagePay
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
orderNo | string | - | 自定义订单号 | 是 |
amount | number | - | 订单金额。例如:0.01 | 是 |
subject | string | - | 商品名称 | 是 |
returnUrl | string | - | 支付完成后返回的URL地址 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | string | 响应数据 | 否 |
error | string | 错误信息 | 否 |
创建订单 - WAP支付☍
接口说明
创建一个WAP支付订单,并返回支付页面。
基本信息☍
- 接口名称:创建订单 - WAP支付
- 请求方式:POST
- 请求路径:/Alipay/{appKey}/CreateOrderWapPay
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
orderNo | string | - | 自定义订单号 | 是 |
amount | number | - | 订单金额。例如:0.01 | 是 |
subject | string | - | 商品名称 | 是 |
returnUrl | string | - | 支付完成后返回的URL地址 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | string | 响应数据 | 否 |
error | string | 错误信息 | 否 |
订单详情☍
接口说明
查询订单详情,包括订单状态和支付信息。
基本信息☍
- 接口名称:订单详情
- 请求方式:GET
- 请求路径:/Alipay/{appKey}/OrderDetail
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
orderNo | string | - | 订单号 | 否 |
示例代码☍
返回结果☍
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | AlipayTradeQueryResponse | - | 否 |
error | string | 错误信息 | 否 |
订单退款☍
接口说明
对指定订单进行退款操作。
基本信息☍
- 接口名称:订单退款
- 请求方式:POST
- 请求路径:/Alipay/{appKey}/OrderRefund
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Query 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
amount | string | - | 退款金额 | 否 |
orderNo | string | - | 订单号 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | AlipayTradeRefundResponse | - | 否 |
error | string | 错误信息 | 否 |
支付成功同步通知☍
接口说明
处理支付宝支付成功的同步通知。
基本信息☍
- 接口名称:支付成功同步通知
- 请求方式:POST
- 请求路径:/Alipay/{appKey}/ReturnPageNotify
请求参数☍
Path 参数☍
参数名 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|
appKey | - | - | 是 |
Body 参数☍
参数名 | 类型 | 示例值 | 参数描述 | 是否必填 |
---|---|---|---|---|
app_id | string | - | 应用ID | 否 |
auth_app_id | string | - | 授权应用ID | 否 |
charset | string | - | 字符集 | 否 |
method | string | - | 接口名称 | 否 |
out_trade_no | string | - | 商户订单号 | 否 |
seller_id | string | - | 卖家支付宝用户号 | 否 |
sign | string | - | 签名 | 否 |
sign_type | string | - | 签名类型 | 否 |
timestamp | string | - | 时间戳 | 否 |
total_amount | string | - | 订单总金额 | 否 |
trade_no | string | - | 支付宝交易号 | 否 |
version | string | - | 接口版本 | 否 |
示例代码☍
返回结果☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
数据结构☍
AlipayCreateOrderPagePayRequest☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
orderNo | string | 自定义订单号 | 是 |
amount | number | 订单金额。例如:0.01 | 是 |
subject | string | 商品名称 | 是 |
returnUrl | string | 支付完成后返回的URL地址 | 否 |
AlipayCreateOrderRequest☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
orderNo | string | 自定义订单号 | 是 |
amount | number | 订单金额。例如:0.01 | 是 |
subject | string | 商品名称 | 是 |
returnUrl | string | 支付完成后返回的URL地址 | 否 |
AlipayCreateOrderWapPayRequest☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
orderNo | string | 自定义订单号 | 是 |
amount | number | 订单金额。例如:0.01 | 是 |
subject | string | 商品名称 | 是 |
returnUrl | string | 支付完成后返回的URL地址 | 否 |
AlipayTradeQueryResponse☍
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
|
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | string | - | 否 |
msg | string | - | 否 |
subCode | string | - | 否 |
subMsg | string | - | 否 |
isError | boolean | - | 否 |
additionalStatus | string | - | 否 |
alipayStoreId | string | - | 否 |
alipaySubMerchantId | string | - | 否 |
asyncPayApplyStatus | string | - | 否 |
authTradePayMode | string | - | 否 |
bizSettleMode | string | - | 否 |
bkagentRespInfo | - | - | 否 |
body | string | - | 否 |
buyerLogonId | string | - | 否 |
buyerOpenId | string | - | 否 |
buyerPayAmount | string | - | 否 |
buyerUserId | string | - | 否 |
buyerUserName | string | - | 否 |
buyerUserType | string | - | 否 |
cashierType | string | - | 否 |
chargeAmount | string | - | 否 |
chargeFlags | string | - | 否 |
chargeInfoList | array | - | 否 |
creditBizOrderId | string | - | 否 |
creditPayMode | string | - | 否 |
discountAmount | string | - | 否 |
discountGoodsDetail | string | - | 否 |
enterprisePayInfo | - | - | 否 |
extInfos | string | - | 否 |
fulfillmentDetailList | array | - | 否 |
fundBillList | array | - | 否 |
hbFqPayInfo | - | - | 否 |
hybAmount | string | - | 否 |
industrySepcDetail | string | - | 否 |
industrySepcDetailAcc | string | - | 否 |
industrySepcDetailGov | string | - | 否 |
intactChargeInfoList | array | - | 否 |
invoiceAmount | string | - | 否 |
mdiscountAmount | string | - | 否 |
medicalInsuranceInfo | string | - | 否 |
openId | string | - | 否 |
outTradeNo | string | - | 否 |
passbackParams | string | - | 否 |
payAmount | string | - | 否 |
payCurrency | string | - | 否 |
paymentInfoWithIdList | array | - | 否 |
periodScene | string | - | 否 |
pointAmount | string | - | 否 |
preAuthPayAmount | string | - | 否 |
receiptAmount | string | - | 否 |
receiptCurrencyType | string | - | 否 |
reqGoodsDetail | array | - | 否 |
sendPayDate | string | - | 否 |
settleAmount | string | - | 否 |
settleCurrency | string | - | 否 |
settleTransRate | string | - | 否 |
settlementId | string | - | 否 |
storeId | string | - | 否 |
storeName | string | - | 否 |
subject | string | - | 否 |
tapPayInfo | - | - | 否 |
terminalId | string | - | 否 |
totalAmount | string | - | 否 |
tradeNo | string | - | 否 |
tradeSettleInfo | - | - | 否 |
tradeStatus | string | - | 否 |
transCurrency | string | - | 否 |
transPayRate | string | - | 否 |
voucherDetailList | array | - | 否 |
AlipayTradeQueryResponseApiResponse☍
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
|
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
AlipayTradeRefundResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | string | - | 否 |
msg | string | - | 否 |
subCode | string | - | 否 |
subMsg | string | - | 否 |
body | string | - | 否 |
isError | boolean | - | 否 |
buyerLogonId | string | - | 否 |
buyerOpenId | string | - | 否 |
buyerUserId | string | - | 否 |
fundChange | string | - | 否 |
gmtRefundPay | string | - | 否 |
hasDepositBack | string | - | 否 |
openId | string | - | 否 |
outTradeNo | string | - | 否 |
preAuthCancelFee | string | - | 否 |
presentRefundBuyerAmount | string | - | 否 |
presentRefundDiscountAmount | string | - | 否 |
presentRefundMdiscountAmount | string | - | 否 |
refundChargeAmount | string | - | 否 |
refundChargeInfoList | array | - | 否 |
refundCurrency | string | - | 否 |
refundDetailItemList | array | - | 否 |
refundFee | string | - | 否 |
refundHybAmount | string | - | 否 |
refundPresetPaytoolList | - | - | 否 |
refundSettlementId | string | - | 否 |
refundVoucherDetailList | array | - | 否 |
sendBackFee | string | - | 否 |
storeName | string | - | 否 |
tradeNo | string | - | 否 |
AlipayTradeRefundResponseApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | - | - | 否 |
error | string | 错误信息 | 否 |
BkAgentRespInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
bindclrissrId | string | - | 否 |
bindpyeracctbkId | string | - | 否 |
bindtrxId | string | - | 否 |
bkpyeruserCode | string | - | 否 |
estterLocation | string | - | 否 |
BooleanApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | boolean | 响应数据 | 否 |
error | string | 错误信息 | 否 |
ChargeInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
chargeFee | string | - | 否 |
chargeType | string | - | 否 |
isRatingOnSwitch | string | - | 否 |
isRatingOnTradeReceiver | string | - | 否 |
originalChargeFee | string | - | 否 |
subFeeDetailList | array | - | 否 |
switchFeeRate | string | - | 否 |
ContributeDetail☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
contributeAmount | string | - | 否 |
contributeType | string | - | 否 |
EnterprisePayInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
bizInfo | string | - | 否 |
invoiceAmount | string | - | 否 |
isUseEnterprisePay | boolean | - | 否 |
FulfillmentDetail☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
fulfillmentAmount | string | - | 否 |
gmtPayment | string | - | 否 |
outRequestNo | string | - | 否 |
GoodsDetail☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
alipayGoodsId | string | - | 否 |
body | string | - | 否 |
categoriesTree | string | - | 否 |
goodsCategory | string | - | 否 |
goodsId | string | - | 否 |
goodsName | string | - | 否 |
outItemId | string | - | 否 |
outSkuId | string | - | 否 |
price | string | - | 否 |
quantity | integer | - | 否 |
showUrl | string | - | 否 |
HbFqPayInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
fqAmount | string | - | 否 |
userInstallNum | string | - | 否 |
IntactChargeInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
actualAmount | string | - | 否 |
billType | string | - | 否 |
gmtPay | string | - | 否 |
isRefund | boolean | - | 否 |
outBizNo | string | - | 否 |
planAmount | string | - | 否 |
productName | string | - | 否 |
serviceTarget | string | - | 否 |
serviceType | string | - | 否 |
status | string | - | 否 |
targetAccountNo | string | - | 否 |
targetUserId | string | - | 否 |
PaymentInfoWithId☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
paymentIds | array | - | 否 |
type | string | - | 否 |
PresetPayToolInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | array | - | 否 |
assertTypeCode | string | - | 否 |
RefundChargeInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
chargeType | string | - | 否 |
refundChargeFee | string | - | 否 |
refundSubFeeDetailList | array | - | 否 |
switchFeeRate | string | - | 否 |
RefundSubFee☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
refundChargeFee | string | - | 否 |
switchFeeRate | string | - | 否 |
ReturnPageNotifyRequest☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
app_id | string | 应用ID | 否 |
auth_app_id | string | 授权应用ID | 否 |
charset | string | 字符集 | 否 |
method | string | 接口名称 | 否 |
out_trade_no | string | 商户订单号 | 否 |
seller_id | string | 卖家支付宝用户号 | 否 |
sign | string | 签名 | 否 |
sign_type | string | 签名类型 | 否 |
timestamp | string | 时间戳 | 否 |
total_amount | string | 订单总金额 | 否 |
trade_no | string | 支付宝交易号 | 否 |
version | string | 接口版本 | 否 |
StringApiResponse☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
code | integer | 状态码 | 否 |
data | string | 响应数据 | 否 |
error | string | 错误信息 | 否 |
SubFee☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
chargeFee | string | - | 否 |
originalChargeFee | string | - | 否 |
switchFeeRate | string | - | 否 |
TapPayInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
paymentMediumType | string | - | 否 |
TradeFundBill☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | string | - | 否 |
bankCode | string | - | 否 |
fundChannel | string | - | 否 |
fundType | string | - | 否 |
realAmount | string | - | 否 |
TradeSettleDetail☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | string | - | 否 |
operationDt | string | - | 否 |
operationSerialNo | string | - | 否 |
operationType | string | - | 否 |
oriTransIn | string | - | 否 |
oriTransOut | string | - | 否 |
transIn | string | - | 否 |
transOut | string | - | 否 |
TradeSettleInfo☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
tradeSettleDetailList | array | - | 否 |
tradeUnsettledAmount | string | - | 否 |
VoucherDetail☍
字段名 | 类型 | 描述 | 是否必填 |
---|---|---|---|
amount | string | - | 否 |
id | string | - | 否 |
memo | string | - | 否 |
merchantContribute | string | - | 否 |
name | string | - | 否 |
otherContribute | string | - | 否 |
otherContributeDetail | array | - | 否 |
purchaseAntContribute | string | - | 否 |
purchaseBuyerContribute | string | - | 否 |
purchaseMerchantContribute | string | - | 否 |
templateId | string | - | 否 |
type | string | - | 否 |
通用错误码☍
错误码 | 说明 |
---|---|
200 | 成功 |