2231-验证短信验证码
1. 接口功能
根据请求报文中的手机号和验证码,验证是否匹配。验证通过后,该验证码失效。(测试环境没有发送真实的短信,短信验证码只有输入123456才可以验证通过。)
交易判断结果:Code 2000为我方对交易的计费标识,即:Code2000的结果均为计费交易。在Code为2000的基础上,以 Status或Verification字段返回结果来判断这笔交易业务处理的最终结果。
2. 报文结构
请求报文:
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 |
|---|---|---|---|---|
| TxCode | R | NOT NULL | N1..4 | 交易类型 |
| InstitutionID | R | NOT NULL | ANS1..8 | 机构编号 |
| TxSN | R | NOT NULL | ANS1..32 | 交易流水号 |
| PhoneNumber | R | NOT NULL | N1..11 | 手机号 |
| ValidCode | R | NOT NULL | N4..8 | 验证码 |
| Remark | O | ANS0..256 | 备注 |
响应报文:
| 报文元素 | 出现要求 | 非空约束 | 数据格式 | 说明 |
|---|---|---|---|---|
| Code | R | NOT NULL | N1..6 | 响应代码 |
| Message | R | NOT NULL | ANS1..256 | 响应消息 |
| TxCode | C | NOT NULL | ANS1..4 | 交易类型 |
| InstitutionID | C | NOT NULL | ANS1..8 | 机构编号 |
| TxSN | C | NOT NULL | ANS1..32 | 交易流水号 |
| TraceNo | C | NOT NULL | ANS1..32 | 交易跟踪号 |
| ResponseCode | C | NOT NULL | N0..4 | 通道响应代码 |
| ResponseMessage | C | NOT NULL | ANS0..256 | 通道响应消息 |
| Verification | C | NOT NULL | N2 | 验证结果 20-匹配 30-不匹配 |
3.报文样例:
[!TIP] (测试数据不校验数据真实性,默认为验证结果为匹配,若验证其他结果,可查看“总体规范-6.1.2.4 Remark 备注”)
请求报文(InstitutionID由中金分配):
{
"TxCode":"2231",
"InstitutionID":"XXXXXX",
"ValidCode":"123456",
"TxSN":"202301131122046626525436104",
"PhoneNumber":"18846439987",
"Remark":""
}
响应报文:
{
"ResponseCode":"0000",
"TxCode":"2231",
"Message":"SUCCESS",
"InstitutionID":"XXXXXX",
"TxSN":"202301131122046626525436104",
"Verification":"20",
"ResponseMessage":"匹配",
"Code":"2000",
"TraceNo":"2301131122180171112015653"
}
该文档未解决您的疑问?
查看常见问题