概念
其他参数
本课程提供了一个不同端点及其附加参数的列表。
用户
创建用户
下表列出了在创建用户时可使用的部分附加请求参数。我们可以在使用 {BASE_URL}/users 端点创建用户时,将这些参数添加到请求体中。点击 此处 获取可用于创建用户的完整请求参数列表。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| middle_name | 字符串 | 可选 | 用户的中间名,最大长度:40 个字符 |
| gender | 字符串 | 可选 | 用户的性别,允许值:M(男)、F(女) |
| birth_date | 字符串 | 可选 | 用户的出生日期,格式:yyyy-MM-dd |
| city | 字符串 | 可选 | 与用户地址对应的城市,最大长度:40 个字符 |
| state | 字符串 | 可选 | 与用户地址对应的两位州代码,示例值:NY、WA、TX |
| postal_code | 字符串 | 可选 | 与用户地址对应的邮政编码,最大长度:10 个字符 |
| id_card_number | 字符串 | 可选 | 用户的身份证明号码,最大长度:255 个字符 |
| nationality | 字符串 | 可选 | 用户的国籍,最大长度:255 个字符 |
| passport_number | 字符串 | 可选 | 用户的护照号码,最大长度:40 个字符 |
| ssn | 字符串 | 可选 | 用户的社会安全号码,注意:仅包含数字,不包含分隔符 |
卡产品
创建卡产品
下表列出了 config 对象的部分属性,该对象是创建卡产品时的一个可选输入参数。点击 此处 查看 config 对象的完整属性列表。
请求参数
| 参数 | 类型 | 类别 | 描述 |
|---|---|---|---|
| config.poi | 对象 | 可选 | 定义卡片的交互点 |
| config.poi.ecommerce | 布尔值 | 可选 | 为 true 表示允许通过卡片进行线上购物,否则为 false,默认值:false |
| config.poi.atm | 布尔值 | 可选 | 为 true 表示允许从 ATM 提现以及在销售点(POS)获取现金返还,否则为 false,默认值:false |
| config.transaction_controls | 对象 | 可选 | 定义卡片使用的交易特性 |
| 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 | 对象 | 可选 | 卡片的收件人地址 |
创建卡片状态变更
下表提供了 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 个字符 |
交易
模拟和撤销交易
下表提供了 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
点击 此处 查看完整的交易类型列表。