测试接口:https://api.bigesim.com/api/payTest
正式接口:https://api.bigesim.com/api/pay
| 字段名 | 字段值 | 操作 |
|---|---|---|
| + 添加字段 | ||
| 字段名 | 字段值 | 操作 |
|---|---|---|
| + 添加字段 | ||
* token用于请求头部(Headers)或请求参数(Params)皆可
{
"status": true,
"code": 0,
"msg": "订单生成成功",
"data": {
"sn": "231013169",
"clientOrderNo": "your-order-no-001",
"verifyCode": "123456",
"currency": "USD",
"categoryId": 31,
"consumption": 5,
"carrier": "中国移动CMHK",
"brand": "CMLink",
"lpa": "LPA:1$xxx.prod.xxxxxxxxxxx.com$TEST1234569868",
"iccid": "89852070322460401234",
"number": "86866878",
"balance": 77,
"activationStatus": "activated",
"qrcode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAG8AAABvAQMAAADYCwwjAAAABlBMVEX///8AAABVwtN+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAABHElEQVQ4jdXUsY3FIAwGYD9R0CULIGUNOq+ULJCQBZKV6LKGJRbIdRQIn/Pe6d41F9M+lOYrQMb+CcAnrp45eAA0zKSyA7NGN8UUoIGYNjvsMe25iWtMJ5pm0txIMAHT158ibyj33XyS7/f6N7y2W2nOu5k37DNXKFN89lMlw3KUR0wVdIJNAQnQzZ5U9pGWXEaEhUElgPTcLZH6JrqJDQtjC5nzENBU1NnnMvFwWje+ZnRLyWrwNGXqWghuxmum+6Gzs+aU0EpzMqh8XAkpMv0ZdXZe3pc5PVer8xUAsNJJUvlMrJvtzyu7p7wFqX/01PkG4rVLTqjQxGDL6M1+QAs3K9mmx/tH8T+lKuCKElqdUs9+mJWHDXR+3voG0+/cX8m0/MsAAAAASUVORK5CYII="
}
}
| 字段 | 类型 | 说明 |
|---|---|---|
| token | string |
访问信令,用于请求接口的身份验证 |
| categoryId | number |
eSim类型ID |
| memberCategoryId | number |
发布者定价ID(可选,对应产品接口中memberCategoryList的id;不传时默认取该分类下最便宜的发布者;若指定ID不存在则不会继续查找其他供应商) |
| uploadMemberCode | string |
发布者编码(可选,对应产品接口中uploadMemberData的code,即上传者ID的编码;传入后优先筛选该发布者的产品,若该发布者无可用产品则自动查找分类下其他供应商的最低价) |
| notifyUrl | string |
回调通知地址(可选,仅支持HTTP/HTTPS;eSim开通成功后系统会POST通知该地址,详见回调通知文档) |
| clientOrderNo | string |
客户订单号(可选,最长64字符;下单响应与开通回调中原样回显,便于请求方关联自己的业务订单,无需维持单一HTTP连接) 下单幂等:同一账号下相同 clientOrderNo 重复或并发提交只会生成一笔订单、扣款一次,后续提交直接返回已存在的该笔订单;未传 clientOrderNo 则不做此限制,每次提交均生成新订单。 |
| maxAmount | number |
最高接受金额(可选,单位 USD;仅传金额不传币种,系统内采价与扣款均以 USD 计)。 传入后:当自动匹配到的采购价格(未指定发布者时为新价格最低发布者切换后的价格)超过该上限,将直接拒单、不扣款,返回 code=4012;不传或为 0 则不设上限。价格仍会自动切换到最低价发布者。 |
| 字段 | 类型 | 说明 |
|---|---|---|
| status | boolean |
【请求状态】 true - 请求成功 false - 请求失败 |
| code | number |
【状态码】 0 - 订单创建成功 203 - 订单已存在 202 - 该 clientOrderNo 订单正在处理中,请稍后查询 4001 - 余额不足 4002 - eSim库存不足 4012 - 采购价格超过最高接受金额(传入 maxAmount 且价格超上限,未扣款) 4003 - token无对应用户 4004 - 参数错误 4007 - 类型不存在 4009 - IP不在白名单内,或下单扣费、开卡生成失败 4013 - 请求过于频繁,请稍后再试(每个会员默认 60 次/分钟) 40111 - 账号未完成认证,不允许调用API |
| msg | string |
【请求说明】 |
| data | object |
【请求数据】 sn - 订单号 clientOrderNo - 客户订单号(原样回显请求方传入的clientOrderNo,未传则不返回) currency - 货币类型 categoryId - eSim类型ID consumption - 本次订单消耗余额 carrier - 运营商 brand - 品牌 balance - token对应账号剩余余额 activationStatus - eSim开通状态(activated - 已开通,返回卡信息字段;activating - 开通中,不返回卡信息字段;下单时传了notifyUrl请等待开通成功后的回调通知,未传可稍后查询订单详情接口) lpa - eSim配置(用于生成二维码) iccid - eSim卡ICCID number - eSim卡号码 qrcode - eSim配置二维码(base64格式) verifyCode - eSim配置验证码 注意:部分eSim开通非实时,下单后可能不会立即完成开通。当activationStatus为activating(开通中)时,不返回卡信息字段(verifyCode、lpa、number、qrcode)。 注意:回调通知的作用——下单时传入notifyUrl后,eSim开通成功系统会主动回调通知该地址,无需频繁轮询订单接口;activationStatus为activating(开通中)时请等待回调通知,详见回调通知文档;未传入notifyUrl时需稍后查询订单详情接口获取卡信息。 qrcode字段为图片base64格式,可作为图片地址引入 <img src="data:image/png;base64,iVBORw0...SuQmCC" alt="" width="240" height="240"> |