- 集成指南
- 实施 Hosted Payment Session 集成
- 使用 Hosted Payment Session POST 模型的 Hosted Payment Session
- Hosted Payment Session: 字段参考
Hosted Payment Session: 字段参考
Hosted Payment Session 字段用于从付款人处收集卡详细信息 - 提交的表单通过 HTTPS POST 直接发布到 Hosted Payment Session 服务。 这是通过会话执行付款或存储交易的先决条件。
提交付款页不会发起付款交易。
在提交付款页之前，您必须使用 Create Session 操作创建一个会话。
Create Session API 参考[REST][NVP]
此操作返回一个会话标识符，您必须在提交付款页时将其嵌入到 Hosted Payment Session 服务 URL 中。表单响应与请求参数一起在经过验证的表单中返回给您。 这使得您可以使用会话标识符代替卡详细信息来执行操作。 有关详细信息，请参见使用会话执行操作。
HTTPS 方法 POST
表单 URL https://testpg.mpgs.axisbank.com/form/<formSessionIdentifier>
身份验证 使用会话标识符验证会话。
请求参数
如果请求参数值错误，则会在字段值中返回错误（参见错误处理）或将付款人（或集成测试人员）重定向到详细说明错误的页面。
提交卡详细信息后，您希望将付款人重定向到的 URL。 如果 URL 缺失或无效，则浏览器中将显示一个页面，详细说明错误。 在付款单中，此字段必须标记为
hidden (<input type="hidden"/>)。
存在
强制
验证规则
必须是完全合格的 URL，以 HTTP:// 或 HTTPS:// 开头，最好是后者，因为建议浏览器返回到受 SSL 保护的页面。 这将阻止指示付款人被返回到不安全网站的浏览器弹出窗口。
最小长度
8
最大长度
2000
卡上打印的付款人信用卡号。
- 隐藏： 在表单响应中返回时，卡号将根据商家的隐藏设置或 6.4（以较严格者为准）隐藏（例如，000000xxxxxx0000）。 如果付款人在初始提交中输入了任何隐藏字符，该值将被作为无效值拒绝。
- 删除： 付款人输入中的任何空格或连字符都会被从响应中删除。
- 截断： 如果输入超过最大长度，响应将被截断至最大长度，并会在响应字段中显示错误。
- 错误： 如果字段值无效，您可以重新显示表单（包含隐藏卡号），指示字段出错。
- 重新提交： 如果重新提交表单（包含响应值）并提交隐藏卡号（未更改），Hosted Payment Session 将作为初始输入的卡号接受提交的数据。
- 隐藏字符： 默认隐藏字符为“
x”。 您可以在重新提交时将隐藏字符替换为“X”或“*”，它将被识别为有效隐藏。
存在
可选
固定值
验证规则
数据是由字符 0-9、“ ”（空格）、“-”（连字符）组成的字符串。
隐藏字符（“
隐藏字符（“
x”、“X”和“*”）仅在重新提交时有效。 最小长度
1
最大长度
30
付款人的卡安全码，印在卡的背面或正面。
- 隐藏： 在表单响应中返回时，卡安全码将完全隐藏（例如，
xxxx）。 如果付款人在初始提交中输入了任何隐藏字符，该值将被作为无效值拒绝。 - 截断： 如果输入超过最大长度，响应将被截断至最大长度，并会在响应字段中显示错误。
- 错误： 如果字段值无效，您可以重新显示表单（包含隐藏卡安全码），指示字段出错。
- 重新提交： 如果重新提交表单（包含响应值）并提交隐藏 CSC（未更改），Hosted Payment Session 将作为初始输入的 CSC 接受提交的数据。
- 隐藏字符： 默认隐藏字符为“
x”。 您可以在重新提交时将隐藏字符替换为“X”或“*”，它将被识别为有效隐藏。 初始提交中的任何隐藏字符都将被视为无效。
存在
可选
固定值
验证规则
数据是由字符 0-9 组成的字符串。
隐藏字符（“
隐藏字符（“
x”、“X”和“*”）仅在重新提交时有效。 最小长度
0
最大长度
10
过期月份，如卡上所示。 月份编号为一月=1，直到十二月=12。 如果字段值无效，您可以重新显示表单，表明该字段有错误。
存在
强制
固定值
验证规则
数据是以字符串表示的 1 到 12 之间的数字。
最小长度
1
最大长度
2
过期年份，如卡上所示。 公元年份是 2000 加上此值。 如果字段值无效，您可以重新显示表单，指出该字段有错误。
存在
强制
固定值
验证规则
数据是由字符 0-9 组成的字符串。 值必须在 2000 到 2099 或 00 到 99 之间。
最小长度
2
最大长度
4
表单响应被回发到商家集成之前，付款人的浏览器中呈现的页面的背景颜色。 建议您指定的颜色与您网站的配色方案完美融合，以便为付款人提供无缝体验。 在付款单中，此字段必须标记为 hidden (
<input type="hidden"/>)。
存在
可选
验证规则
以下 CSS 表示被视为有效。
无效值将从输入中删除并使用默认值。
无效值将从输入中删除并使用默认值。
- 十六进制： 十六进制表示法的 RGB 值的格式为“
#”，后面紧跟三个或六个十六进制字符。 例如，#F00、#FF0000 - 颜色名称： 颜色名称如“
red”、“white”等 - RGB 值： “
rgb”后跟 3 个数值，以括号括住。例如， “rgb(255,0,0)”
默认值
#000000 (white)
最小长度
3
最大长度
30
表单响应被回发到商家集成之前，付款人的浏览器中呈现的页面的标题。 建议您指定的标题能够让付款人感觉是连续的，从而增强购物体验。 在付款单中，此字段必须标记为 hidden (
<input type="hidden"/>)。
存在
可选
验证规则
文本
默认值
提交的付款详细信息
最小长度
0
最大长度
255
禁用 JavaScript 时将呈现在付款人浏览器中的按钮的标题。 建议您为按钮指定的文本能够与付款人的购物体验良好匹配。 单击此按钮会将表单响应回发到商家集成。 在付款单中，此字段必须标记为 hidden (
<input type="hidden"/>)。
存在
可选
验证规则
文本
默认值
单击此处继续
最小长度
0
最大长度
255
响应参数
请求中提交的所有参数都将在响应中返回。 此外，还将返回以下参数。
仅当您使用 15+ 版本中的 Create Session 请求时，才会返回字段 gatewayCardBrand、gatewayCardLocalBrand 和 gatewayCardFundingMethod。
表示表单提交的总体结果。
存在
始终返回
验证规则
一般响应代码，格式为 R~D，其中 R 为表示结果的单字符代码，D 为英文说明。 在处理表单响应中的其他字段之前必须检查此值。
值必须是以下列表中的值。 这些值区分大小写。
0~OK
指示表单有效 — 在未发现表单错误时返回。
2~Session identifier invalid or closed for updates
指示会话无效 — 在缺少会话、会话已过期、结束或无效时返回。
3~Field Errors
指示字段错误 — 有任何表单字段验证失败时返回。
4~System Error
指示系统错误 — 在发生支付网关错误或其他失败时返回。
从所提供卡的确定的卡组织。
存在
始终返回
验证规则
值必须是以下列表中的值。 这些值区分大小写。
AMEX
American Express
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
MASTERCARD
Mastercard
UATP
UATP (Universal Air Travel Plan)
VISA
Visa
OTHER
无法识别用于交易的卡组织。
用于描述全球认可和接受的卡的品牌名称。 对于许多主要卡类型，这将与组织名称匹配。在某些市场中，卡还可能作为在原始国家/地区得到认可和接受的本地品牌的联名卡（请参见 gatewayCardLocalBrand）。 您可以使用此信息来支持附加费决定。 此信息是从第三方来源收集的，可能并非在任何情况下都准确。
存在
始终返回
验证规则
值必须是以下列表中的值。 这些值区分大小写。
AMEX
American Express
DINERS_CLUB
Diners Club
DISCOVER
Discover
JCB
JCB (Japan Credit Bureau)
MAESTRO
Maestro
MASTERCARD
Mastercard
VISA
Visa
UATP
UATP (Universal Air Travel Plan)
LOCAL_BRAND_ONLY
该卡没有全球品牌。
UNKNOWN
无法识别交易中使用的卡的品牌。
用于描述在原始国家/地区内被认可和接受的卡的品牌名称。 此卡还可能与全球认可和接受的品牌名称联名（参见 gatewayCardBrand）。 您可以使用此信息来支持附加费决定。 此信息是从第三方来源收集的，可能并非在任何情况下都准确。
存在
条件
验证规则
值必须是以下列表中的值。 这些值区分大小写。
BANAMEX_COSTCO
Banamex Costco（墨西哥）
CARNET
Carnet（墨西哥）
CARTE_BANCAIRE
Carte Bancaire（法国）
ELO
Elo（巴西）
FARMERS
Farmers Card（新西兰）
LASER
Laser（爱尔兰）
Q_CARD
Q Card（新西兰）
SORIANA
Soriana（墨西哥）
TRUE_REWARDS
True Rewards（新西兰）
付款人提供付款资金所使用的方法。 您可以使用此信息来支持附加费决定。 此信息是从第三方来源收集的，可能并非在任何情况下都准确。
存在
始终提供
验证规则
值必须是以下列表中的值。 这些值区分大小写。
CHARGE
付款人在发卡机构处有信用额度，必须每月偿还。
CREDIT
付款人在发卡机构有循环信用额度。
DEBIT
资金立即记入付款人在发卡机构的账户。
UNKNOWN
无法确定账户的资金提供方式。
URL 参数
参数： {formSessionIdentifier}
APICreate Session 操作的响应返回的会话识别码。 此值必须作为表单上的操作追加到 Hosted Payment Session 服务 URL。
例如，
例如，
action="https://testpg.mpgs.axisbank.com/form/SESSION000112345678901234567890"
类型
字母数字
数据必须采用以下格式： "SESSION" 后跟 24 个数字 (0-9)，
例如，
例如，
SESSION000112345678901234567890最小长度
31
最大长度
31