文档管理中心
我的

您当前正在浏览HarmonyOS最新文档,覆盖已发布的所有API版本,可在API参考中筛选您使用的API版本。详细的版本配套关系请参考版本说明。

指南与API参考API参考应用服务Payment Kit(鸿蒙支付服务)REST API通用接口实名信息验证与授权实名信息验证结果查询

实名信息验证结果查询

功能介绍

开发者可以调用该接口查询实名信息验证结果。

场景描述

开发者在用户实名信息验证后,需要获取实名信息验证结果。

接口原型

  • 承载协议: HTTPS POST

  • 接口方向: 开发者服务器 -> 华为支付服务器

  • 接口URL: https://petalpay-developer.cloud.huawei.com.cn/api/v1/realname/verification/result

  • 数据格式:

    请求消息:Content-Type: application/json; charset=UTF-8

    响应消息:Content-Type: application/json; charset=UTF-8

请求参数

Request Header

展开
参数 是否必选 参数类型 描述
Content-Type 是 String 取值为:application/json; charset=UTF-8
PayDevAuth 是 String 取值为:PayDevAuth的JSON字符串

Request Body

展开
参数 是否必选 类型 说明
verifyResultId 是 String 实名信息验证ID。应用端接口返回的用户实名信息验证ID。
openId 是 String 用户对外展示的ID(获取方式请参见获取用户信息)。长度范围为1-512。

请求示例

POST /api/v1/realname/verification/result HTTP/1.1
Content-Type: application/json;charset=UTF-8
PayDevAuth: {"clientId":"10132120***","accessToken":"DQEBALZh0tlSKKiNDJ9lYYg0Du0EB3E6PvcGlFsyB*******************XR+k2EX8ry1IGdDUZG1PjfcWQ94xnK7w3ag==","traceId":"202305151026422776499","time":1684117602555, "developerSignKeyId":"76e5ee072756417a829201fa********************f9a292d23ca949202c3dac548120", "petalpaySignKeyId":"DEVELOPER_SIGN_EB48251AC36***", "headerSign":"u+H3F14Oe3fS34d32S9mGCES89XA7tSjp8+********************lOGS7eADFfw2E45WJu52vY5Ku4KGcSCnSeE6DiKs=", "bodySign":"y3DFDtDLXDBqDoItDgHmFJ343H57LKH6U5G7F/*******************asPj10iDUIFeHaszDFHpiHRT23LGHaxvHJKta6J5UxIUmApL+wGdV/juGEvQ="}
Accept: application/json
{
  "verifyResultId": "12407091401520894056950***",
  "openId": "88e9eae22447d7a138357cbf0af2d9a3a84819ec18419631c*******************2b9cc4e33ad29e2048318b47ec98be41cecdd4e153e6216a6bd60851"
}

响应参数

Response Header

展开
参数 是否必选 参数类型 描述
Content-Type 是 String 取值为:application/json; charset=UTF-8

Response Body

展开
参数 是否必选 参数类型 描述
resultCode 是 String 返回码,“000000”表示成功,其他表示异常,请参见错误码。
resultDesc 是 String 结果描述。
subCode 否 String 业务错误码。
subDesc 否 String 业务错误描述信息。
sign 是 String 签名值。用于开发者对响应报文进行防篡改验证。
verifyResult 是 Boolean 实名验证结果。
failedReason 否 String

开发者预期可以感知的验证错误原因。

- ID_TYPE_NOT_SUPPORT:证件类型不支持(当前华为支付开放实名验证能力仅支持身份证)

- RARE_WORD_NOT_SUPPORT:生僻字场景不支持 (如姓名中携带了生僻字)

响应示例

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
{
  "resultCode": "000000",
  "resultDesc": "Success.",
  "sign": "MEQCIEIWzdpziRyTi8vhwWHFu********************0YAMabeCgTDG77e+2XJItvq/ZkIcCN5/B20pQ==",
  "verifyResult": true
}

错误码

resultCode非400000的错误码请查看公共错误码说明。

展开
返回码 错误码 错误描述 解决方案
400000 UNKNOW_ERROR 服务暂不可用,请稍后重试 稍后重试。
400000 INVALID_ARGUMENTS 参数不合法 检查请求参数。
400000 CLIENT_ID_PARAM_ERROR CLIENT_ID错误 检查请求头参数clientId参数是否正确。
400000 INVALID_OPENID OPEN_ID错误 检查请求入参openId是否正确。