点金计划管理
更新时间:2024.11.18服务商为特约商户开通或关闭点金计划。
接口说明
支持商户:【普通服务商】 【渠道商】
请求方式:【POST】/v3/goldplan/merchants/changegoldplanstatus
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
body 包体参数
sub_mchid 必填 string(32)
【特约商户号】开通或关闭点金计划的特约商户商户号,由微信支付生成并下发。
operation_type 必填 string
【操作类型】开通或关闭点金计划的动作,枚举值:
OPEN:表示开通点金计划
CLOSE:表示关闭点金计划
可选取值:
OPEN
: 开通
CLOSE
: 关闭
operation_pay_scene 选填 string
【支付场景】支付场景,指定开通/关闭点金计划的支付场景。如果未指定,则默认值是JSAPI
可选取值:
JSAPI_AND_MINIPROGRAM
: jsapi支付和小程序支付两个场景
JSAPI
: jsapi支付场景
MINIPROGRAM
: 小程序支付场景
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/goldplan/merchants/changegoldplanstatus \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "sub_mchid" : "1900000109", 8 "operation_type" : "OPEN", 9 "operation_pay_scene" : "JSAPI_AND_MINIPROGRAM" 10 }' 11
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/v3/partner/4014985777 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 点金计划管理 24 */ 25public class ChangeGoldPlanStatus { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/goldplan/merchants/changegoldplanstatus"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 ChangeGoldPlanStatus client = new ChangeGoldPlanStatus( 33 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 34 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 35 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 ChangeGoldPlanStatusRequest request = new ChangeGoldPlanStatusRequest(); 41 request.subMchid = "1900000109"; 42 request.operationType = OperationType.OPEN; 43 request.operationPayScene = OperationPayScene.JSAPI_AND_MINIPROGRAM; 44 try { 45 ChangeGoldPlanStatusResponse response = client.run(request); 46 // TODO: 请求成功,继续业务逻辑 47 System.out.println(response); 48 } catch (WXPayUtility.ApiException e) { 49 // TODO: 请求失败,根据状态码执行不同的逻辑 50 e.printStackTrace(); 51 } 52 } 53 54 public ChangeGoldPlanStatusResponse run(ChangeGoldPlanStatusRequest request) { 55 String uri = PATH; 56 String reqBody = WXPayUtility.toJson(request); 57 58 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 59 reqBuilder.addHeader("Accept", "application/json"); 60 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 61 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 62 reqBuilder.addHeader("Content-Type", "application/json"); 63 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 64 reqBuilder.method(METHOD, requestBody); 65 Request httpRequest = reqBuilder.build(); 66 67 // 发送HTTP请求 68 OkHttpClient client = new OkHttpClient.Builder().build(); 69 try (Response httpResponse = client.newCall(httpRequest).execute()) { 70 String respBody = WXPayUtility.extractBody(httpResponse); 71 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 72 // 2XX 成功,验证应答签名 73 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 74 httpResponse.headers(), respBody); 75 76 // 从HTTP应答报文构建返回数据 77 return WXPayUtility.fromJson(respBody, ChangeGoldPlanStatusResponse.class); 78 } else { 79 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 80 } 81 } catch (IOException e) { 82 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 83 } 84 } 85 86 private final String mchid; 87 private final String certificateSerialNo; 88 private final PrivateKey privateKey; 89 private final String wechatPayPublicKeyId; 90 private final PublicKey wechatPayPublicKey; 91 92 public ChangeGoldPlanStatus(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 93 this.mchid = mchid; 94 this.certificateSerialNo = certificateSerialNo; 95 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 96 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 97 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 98 } 99 100 public static class ChangeGoldPlanStatusRequest { 101 @SerializedName("sub_mchid") 102 public String subMchid; 103 104 @SerializedName("operation_type") 105 public OperationType operationType; 106 107 @SerializedName("operation_pay_scene") 108 public OperationPayScene operationPayScene; 109 } 110 111 public static class ChangeGoldPlanStatusResponse { 112 @SerializedName("sub_mchid") 113 public String subMchid; 114 } 115 116 public enum OperationType { 117 @SerializedName("OPEN") 118 OPEN, 119 @SerializedName("CLOSE") 120 CLOSE 121 } 122 123 public enum OperationPayScene { 124 @SerializedName("JSAPI_AND_MINIPROGRAM") 125 JSAPI_AND_MINIPROGRAM, 126 @SerializedName("JSAPI") 127 JSAPI, 128 @SerializedName("MINIPROGRAM") 129 MINIPROGRAM 130 } 131 132} 133
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 14 config, err := wxpay_utility.CreateMchConfig( 15 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 16 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 17 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &ChangeGoldPlanStatusRequest{ 27 SubMchid: wxpay_utility.String("1900000109"), 28 OperationType: OPERATIONTYPE_OPEN.Ptr(), 29 OperationPayScene: OPERATIONPAYSCENE_JSAPI_AND_MINIPROGRAM.Ptr(), 30 } 31 32 response, err := ChangeGoldPlanStatus(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func ChangeGoldPlanStatus(config *wxpay_utility.MchConfig, request *ChangeGoldPlanStatusRequest) (response *ChangeGoldPlanStatusResponse, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "POST" 47 path = "/v3/goldplan/merchants/changegoldplanstatus" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqBody, err := json.Marshal(request) 55 if err != nil { 56 return nil, err 57 } 58 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 59 if err != nil { 60 return nil, err 61 } 62 httpRequest.Header.Set("Accept", "application/json") 63 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 64 httpRequest.Header.Set("Content-Type", "application/json") 65 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Authorization", authorization) 70 71 client := &http.Client{} 72 httpResponse, err := client.Do(httpRequest) 73 if err != nil { 74 return nil, err 75 } 76 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 77 if err != nil { 78 return nil, err 79 } 80 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 81 // 2XX 成功,验证应答签名 82 err = wxpay_utility.ValidateResponse( 83 config.WechatPayPublicKeyId(), 84 config.WechatPayPublicKey(), 85 &httpResponse.Header, 86 respBody, 87 ) 88 if err != nil { 89 return nil, err 90 } 91 response := &ChangeGoldPlanStatusResponse{} 92 if err := json.Unmarshal(respBody, response); err != nil { 93 return nil, err 94 } 95 96 return response, nil 97 } else { 98 return nil, wxpay_utility.NewApiException( 99 httpResponse.StatusCode, 100 httpResponse.Header, 101 respBody, 102 ) 103 } 104} 105 106type ChangeGoldPlanStatusRequest struct { 107 SubMchid *string `json:"sub_mchid,omitempty"` 108 OperationType *OperationType `json:"operation_type,omitempty"` 109 OperationPayScene *OperationPayScene `json:"operation_pay_scene,omitempty"` 110} 111 112type ChangeGoldPlanStatusResponse struct { 113 SubMchid *string `json:"sub_mchid,omitempty"` 114} 115 116type OperationType string 117 118func (e OperationType) Ptr() *OperationType { 119 return &e 120} 121 122const ( 123 OPERATIONTYPE_OPEN OperationType = "OPEN" 124 OPERATIONTYPE_CLOSE OperationType = "CLOSE" 125) 126 127type OperationPayScene string 128 129func (e OperationPayScene) Ptr() *OperationPayScene { 130 return &e 131} 132 133const ( 134 OPERATIONPAYSCENE_JSAPI_AND_MINIPROGRAM OperationPayScene = "JSAPI_AND_MINIPROGRAM" 135 OPERATIONPAYSCENE_JSAPI OperationPayScene = "JSAPI" 136 OPERATIONPAYSCENE_MINIPROGRAM OperationPayScene = "MINIPROGRAM" 137) 138
应答参数
|
sub_mchid 必填 string
【特约商户号】开通或关闭“商家自定义小票”的特约商户商户号,由微信支付生成并下发。
应答示例
200 OK
1{ 2 "sub_mchid" : "1900000109" 3} 4
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | INVALID_REQUEST | 服务商未开通点金计划 | 请在服务商平台先行开通点金计划后再试 |
400 | INVALID_REQUEST | 服务商被处罚中 | 请在服务商平台处理处罚后再试 |
400 | INVALID_REQUEST | 特约商户被处罚中 | 请让特约商户在商户平台处理处罚后再试 |
400 | INVALID_REQUEST | 操作失败 | 操作失败,请稍后重试 |
400 | MCH_NOT_EXISTS | 特约商户号不存在 | 特约商户号不存在,请确认特约商户号准确性 |