储值卡接口
PrepaidCard 对象
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 卡id |
| cardholder_id | string | 持卡人ID |
| segment_id | string | 卡段ID |
| card_number | string | 卡号 |
| name_on_card | string | 卡名 |
| brand | string | 品牌,如VISA |
| expiry_year | string | 过期年份 |
| expiry_month | string | 过期月份 |
| cvv | string | cvv |
| balance | number | 余额, 单位元 |
| total_consume | number | 累计消费, 单位元 |
| total_recharge | number | 累计充值, 单位元 |
| total_transfer_out | number | 累计转出, 单位元 |
| actual_recharge | number | 实际充值, 单位元 |
| total_refund | number | 累计退款, 单位元 |
| currency | string | 币种, 如USD |
| tag | string | 标签 |
| purpose | list<string> | 使用场景, TIKTOK, FACEBOOK, GOOGLE |
| status | string | 状态, NOPENDING未处理, PENDING待处理, ACTIVE已激活, INACTIVE已失效, BLOCKED已锁定, LOST已丢失, STOLEN已被盗, CLOSED已关闭, FAILED创建失败, EXPIRED已过期 |
| subuser_id | string | 子帐号id, 当查询子帐号储值卡列表时,此值存在 |
| subuser_name | string | 子帐号名称, 当查询子帐号储值卡列表时,此值存在 |
获取储值卡公共信息
URL: GET /prepaid/info
Query: 无
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| max_card_count | number | 最大开卡数 |
| remaining_card_count | number | 剩余可开卡数 |
| balance | number | 卡内余额, 单位元 |
申请总开卡数
URL: POST /prepaid/apply_max_count
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| apply_count | number | 是 | 申请数量 |
| purpose | list<string> | 是 | 使用场景, TIKTOK, FACEBOOK, GOOGLE |
| reason | string | 是 | 申请原因 |
输出: 无
获取储值卡列表
URL: GET /prepaid/card/list?page=1
Query:
| 字段 | 必填 | 说明 |
|---|---|---|
| page | 否 | 页码,从1开始 |
| size | 否 | 每页大小 |
| search | 否 | 搜索关键词 |
| status | 否 | 状态 |
输出: list<PrepaidCard>
新增储值卡
URL: POST /prepaid/card/create
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| segment_id | string | 是 | 卡段ID |
| cardholder_id | string | 是 | 持卡人ID |
| currency | string | 是 | 币种 |
| recharge_amount | number | 是 | 充值金额, 所有金额都是整数且精确到分,如1850,表示18.5元 |
| tag | string | 否 | 标签 |
| purpose | list<string> | 是 | 使用场景, TIKTOK, FACEBOOK, GOOGLE |
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 卡id |
批量修改储值卡标签
URL: POST /prepaid/card/update_tag
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| ids | string | 是 | 卡ID列表 |
输出: 无
储值卡充值
注意: 当前仅支持从钱包充值
URL: POST /prepaid/card/{card_id}/recharge
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| amount | number | 是 | 充值金额, 所有金额都是整数且精确到分,如1850,表示18.5元 |
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| card_balance | number | 储值卡新余额, 单位元 |
| wallet_balance | number | 钱包新余额, 单位元 |
储值卡转出
注意: 当前仅支持转出到钱包
URL: POST /prepaid/card/{card_id}/transfer_out
输入:
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| amount | number | 是 | 转出金额, 所有金额都是整数且精确到分,如1850,表示18.5元 |
输出:
| 字段 | 类型 | 说明 |
|---|---|---|
| card_balance | number | 储值卡新余额, 单位元 |
| wallet_balance | number | 钱包新余额, 单位元 |
冻结卡片
URL: POST /prepaid/card/{card_id}/freeze
输入: 无
输出: 无
解冻卡片
URL: POST /prepaid/card/{card_id}/unfreeze
输入: 无
输出: 无
删除卡片
URL: POST /prepaid/card/{card_id}/delete
输入: 无
输出: 无