调用方式
微卡收付通 API 的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。均使用UTF-8编码。
公共参数
公共参数是用于标识用户和接口签名的参数,如非必要,在每个接口单独的文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
公共参数需要统一放到 HTTP Header 请求头部中,如下表所示:
参数名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Action | string | 是 | HTTP 请求头:X-TC-Action。操作的接口名称。取值参考具体接口文档。若未提及则传默认值 wxpay |
Region | string | 是 | HTTP 请求头:X-TC-Region。默认传 ap-shanghai |
Timestamp | int | 是 | HTTP 请求头:X-TC-Timestamp。当前 UNIX 时间戳,可记录发起 API 请求的时间。例如 1529223702。注意:如果与服务器时间相差超过5分钟,会引起签名过期错误。 |
Version | string | 是 | HTTP 请求头:X-TC-Version。操作的 API 的版本。取值参考接口文档中入参公共参数 Version 的说明。未提及默认传值 2023-04-13 |
Ocode | string | 是 | HTTP 请求头:X-TC-Ocode。微卡收付通主体标识,可在控制台查询获取。 |
Authorization | string | 是 | HTTP 标准身份认证头部字段,例如: TC3-HMAC-SHA256 Credential=AKIDEXAMPLE/Date/service/tc3_request, SignedHeaders=content-type;host;x-tc-ocode;x-tc-action, Signature=fe5f80f77d5fa3beca038a248ff027d0445342fe2855ddc963176630326f1024 其中, - TC3-HMAC-SHA256:签名方法,目前固定取该值; - Credential:签名凭证,AKIDEXAMPLE 是 SecretId;Date 是 UTC 标准时间的日期,取值需要和公共参数 X-TC-Timestamp 换算的 UTC 标准时间日期一致;service 为具体产品名,通常为域名前缀,例如域名 cvm.tencentcloudapi.com 意味着产品名是 cvm。本产品取值为 cvm;tc3_request 为固定字符串; - SignedHeaders:参与签名计算的头部信息,此处默认传值content-type;host;x-tc-ocode;x-tc-action - Signature:签名摘要 |
GET 请求结构示例:
https://p.wecard.tencent.com/order?orderId=xs1
Authorization: TC3-HMAC-SHA256 Credential=AKID********EXAMPLE/2023-04-13/wxpay/tc3_request, SignedHeaders=content-type;host;x-tc-ocode;x-tc-action, Signature=5da7a33f6993f0614b047e5df4582db9e9bf4672ba50567dba16c6ccf174c474
Content-Type: application/x-www-form-urlencoded
Host: p.wecard.tencent.com
X-TC-Action: wxpay
X-TC-Version: 2023-04-13
X-TC-Timestamp: 1681301329
X-TC-Region: ap-shanghai
X-TC-Ocode: 123456
POST 请求结构示例:
https://p.wecard.tencent.com/order
Authorization: TC3-HMAC-SHA256 Credential=AKID********EXAMPLE/2023-04-13/wxpay/tc3_request, SignedHeaders=content-type;host;x-tc-ocode;x-tc-action, Signature=582c400e06b5924a6f2b5d7d672d79c15b13162d9279b0855cfba6789a8edb4c
Content-Type: application/json
Host: p.wecard.tencent.com
X-TC-Action: wxpay
X-TC-Version: 2023-04-13
X-TC-Timestamp: 1681301329
X-TC-Region: ap-shanghai
X-TC-Ocode: 123456
{"orderId":123}