概念
其他参数和响应字段
本课程提供了一个不同端点的列表，以及它们的附加参数和响应字段。
用户
创建用户
下表列出了在使用 {BASE_URL}/users 端点创建用户时，可用于请求体的额外参数。我们可以将这些参数添加到请求体中。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| middle_name | 字符串 | 可选 | 用户的中间名，最大长度：40 个字符 |
| gender | 字符串 | 可选 | 用户的性别 |
| birth_date | 字符串 | 可选 | 用户的出生日期，格式：yyyy-MM-dd |
| city | 字符串 | 可选 | 用户地址对应的城市，最大长度：40 个字符 |
| state | 字符串 | 可选 | 用户地址对应的两位州代码，示例值：NY、WA、TX |
| postal_code | 字符串 | 可选 | 用户地址对应的邮政编码，最大长度：10 个字符 |
| id_card_number | 字符串 | 可选 | 用户的身份证明号码，最大长度：255 个字符 |
| nationality | 字符串 | 可选 | 用户的国籍，最大长度：255 个字符 |
| passport_number | 字符串 | 可选 | 用户的护照号码，最大长度：40 个字符 |
| ssn | 字符串 | 可选 | 用户的社会安全号码，仅包含数字，不包含分隔符 |
下表列出了用户成功创建后返回的部分额外响应字段。
响应字段
| 名称 | 类型 | 描述 |
|---|---|---|
| address1 | 字符串 | 持卡人的地址，最大长度：255 个字符 |
| address2 | 字符串 | 持卡人的附加地址信息，最大长度：255 个字符 |
| authentication | 对象 | 包含持卡人的邮箱、密码、email_verified、email_verified_time、last_password_update_channel 和 last_password_update_time。当邮箱已验证时，authentication.email_verified 为 true，否则为 false。authentication.last_password_update_channel 表示最后一次修改密码所使用的路径。authentication.email_verified_time 和 authentication.last_password_update_time 的格式为：yyyy-MM-ddTHH:mm:ssZ |
| birth_date | 字符串 | 持卡人的出生日期 |
| business_token | 字符串 | 业务资源的唯一标识符 |
| city | 字符串 | 持卡人所在城市 |
| company | 字符串 | 公司名称 |
| 字符串 | 持卡人的有效邮箱地址 | |
| honorific | 字符串 | 持卡人的头衔或前缀，如 Mr.、Ms.、Miss、Mrs. 等 |
| id_card_expiration_date | 字符串 | 持卡人身份证件的到期日期 |
| id_card_number | 字符串 | 持卡人的身份证号码 |
| ip_address | 字符串 | 持卡人的 IP 地址 |
| notes | 字符串 | 关于持卡人的任何附加信息 |
| parent_token | 字符串 | 系统中已有用户或业务的唯一 ID |
| ssn | 字符串 | 持卡人的社会安全号码 |
注意： 点击此处获取此端点相关的完整请求参数和响应字段列表。
卡产品
创建卡产品
下表列出了 config 对象的一些属性，该对象是创建卡产品时的一个可选输入参数。点击此处获取 config 对象属性的完整列表。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| config.poi | 对象 | 可选 | 定义卡片的交互点 |
| config.poi.ecommerce | 布尔值 | 可选 | 为 true 时表示允许通过卡片进行在线购物，否则为 false。默认值：false |
| config.poi.atm | 布尔值 | 可选 | 为 true 时表示允许从 ATM 提现以及在销售点（POS）获取现金返还，否则为 false。默认值：false |
| config.transaction_controls | 对象 | 可选 | 定义卡片使用的交易特性。该对象包含：always_require_pin：为 true 表示卡片交易需要 PIN 码，否则为 false。此为可选参数。 |
| config.transaction_controls.always_require_pin | 布尔值 | 可选 | 为 true 表示卡片交易需要 PIN 码，否则为 false。默认值：false |
卡片
创建卡片
下表展示了 expiration_offset 和 activation_actions 对象的属性，以及用于创建卡片的 fulfillment 对象的一些重要属性。点击此处获取 fulfillment 对象属性的完整列表。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| expiration_offset.value | 整数 | 可选 | 卡片有效期时长，默认值：4 |
| expiration_offset.unit | 字符串 | 可选 | expiration_offset.value 字段的单位，允许值：YEARS、MONTHS、DAYS、HOURS、MINUTES、SECONDS，默认值：YEARS |
| activation_actions.terminate_reissued_source_card | 布尔值 | 可选 | 为 true 表示在重新发行时终止原卡，否则为 false。默认值：true |
| activation_actions.swap_digital_wallet_tokens_from_card_token | 字符串 | 可选 | 从该卡中将所有数字钱包令牌转移到新卡的卡令牌，长度：1–36 个字符 |
| fulfillment.card_personalization | 对象 | 可选 | 添加到卡片上的个性化信息 |
| fulfillment.card_personalization.text | 对象 | 可选 | 显示在卡片上的个性化文本 |
| fulfillment.shipping | 对象 | 可选 | 卡片的配送详情 |
| fulfillment.shipping.recipient_address | 对象 | 可选 | 卡片的收件地址 |
响应字段
| 名称 | 类型 | 描述 |
|---|---|---|
| last_four | 字符串 | 卡片 PAN 的最后四位数字 |
| bar_code | 字符串 | 卡片上打印的条形码，允许值：10–20 个字符 |
| pin_is_set | 布尔值 | 如果卡片设置了个人识别码（PIN），则为 true，否则为 false |
| state_reason | 字符串 | 卡片状态的描述性原因 |
| fulfillment | 对象 | 决定卡片的物理特性和配送信息 |
| expedite | 布尔值 | 如果持卡人要求卡片发放提供商加急处理，则为 true，否则为 false |
| meta_data | 对象 | 包含与卡片一同提供的任何额外元数据 |
注意： 点击此处获取此端点相关的完整请求参数和响应字段列表。
创建卡片变更
下表提供了 validations 对象的详细信息。点击此处查看 channel 和 reason_code 值的说明。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| validations.user | 对象 | 可选 | 包含用户信息 |
| validations.user.birth_date | 日期时间 | 可选 | 持卡人的出生日期，格式：yyyy-MM-dd |
| validations.user.phone | 字符串 | 可选 | 持卡人的电话号码，最大长度：255 个字符，格式：0000000000 或 000-000-0000 |
| validations.user.random_name_line1_postfix | 字符串 | 可选 | 批量发卡订单的六位数字后缀，最大长度：6 个字符 |
| validations.user.ssn | 字符串 | 可选 | 持卡人的社会安全号码，最大长度：255 个字符 |
响应字段
| 名称 | 类型 | 描述 |
|---|---|---|
| last_four | 字符串 | 卡片 PAN 的最后四位数字 |
| bar_code | 字符串 | 卡片上打印的条形码，允许值：10–20 个字符 |
| pin_is_set | 布尔值 | 如果卡片设置了个人识别码（PIN），则为 true，否则为 false |
| reason | 字符串 | 卡片状态的附加信息 |
| channel | 字符串 | 变更发起的机制，允许值：API、IVR、FRAUD、ADMIN、SYSTEM |
| fulfillment | 对象 | 决定卡片的物理特性和配送信息 |
| expedite | 布尔值 | 如果持卡人要求卡片发放提供商加急处理，则为 true，否则为 false |
| validations | 对象 | 包含用户的相关信息 |
| meta_data | 对象 | 包含与卡片一同提供的任何额外元数据 |
注意： 点击此处获取此端点相关的完整请求参数和响应字段列表。
交易
模拟和撤销交易
下表提供了 network_fees 和 webhook 对象的详细信息。点击此处查看 card_acceptor、card_options 和 transaction_options 对象的详细信息。此外，还可找到网络费用类型的说明，以及它们是增加还是减少账户余额。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| network_fees.type | 字符串 | 可选 | 费用类型，允许值：ISSUER_FEE、SWITCH_FEE、PINDEBIT_ASSOC_FEE、ACQUIRER_FEE、INTERCHANGE_FEE、CUR_CONV_CARDHOLDER_FEE、CUR_CONV_ISSUER_FEE、CROSS_BORDER_ISSUER_FEE |
| network_fees.amount | 小数 | 可选 | 费用金额 |
| network_fees.credit_debit | 字符串 | 可选 | C 表示费用增加账户余额，D 表示费用减少账户余额，允许值：C、D |
| webhook.endpoint | 字符串 | 可选 | 用于发送响应副本的链接 |
| webhook.username | 字符串 | 可选 | 访问端点所用的用户名，最大长度：50 个字符 |
| webhook.password | 字符串 | 可选 | 访问端点所用的密码 |
获取所有交易
常见的交易类型包括以下几种：
account.creditaccount.debitbalanceinquiryauthorizationauthorization.atm.withdrawal
点击此处获取交易类型的完整列表。