eSim購買
為方便開發調試,我們提供測試接口用於餘額支付調試。測試接口調試餘額不會被實際扣除,實際部署務必使用正式接口。

測試接口://www.bigesim.com/api/payTest

正式接口://www.bigesim.com/api/pay

請求接口
請求頭部(Headers)
字段名 字段值 操作
+ 添加字段
請求參數(Params)
字段名 字段值 操作
+ 添加字段

* token用於請求頭部(Headers)或請求參數(Params)皆可

響應數據
{ "status": true, "code": 20000, "msg": "订单生成成功", "data": { "sn": "231013169", "verifyCode": "123456", "currency": "USD", "categoryId": 31, "consumption": 5, "carrier": "中国移动CMHK", "brand": "CMLink", "lpa": "LPA:1$xxx.prod.xxxxxxxxxxx.com$TEST1234569868", "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;不傳時默認取該分類下最便宜的發布者)

notifyUrl string

回調通知地址(可選,僅支持HTTP/HTTPS;eSim開通成功後係統會POST通知該地址,詳見回調通知文檔)

響應字段說明
字段 類型 說明
status boolean

【請求狀態】

true - 請求成功

false - 請求失敗

code number

【狀態碼】

20109 - 請求方式不允許

24001 - 類型不存在

24002 - token無對應用戶

22003 - eSim庫存不足

22004 - 訂單生成失敗

24005 - 參數錯誤

21006 - 支付接口請求錯誤

21010 - 餘額不足

21000 - 訂單生成成功

msg string

【請求說明】

data object

【請求數據】

sn - 訂單號

currency - 貨幣類型

categoryId - eSim類型ID

consumption - 本次訂單消耗餘額

carrier - 運營商

brand - 品牌

balance - token對應賬號剩餘餘額


activationStatus - eSim開通狀態(activated - 已開通,返回卡信息字段;activating - 開通中,不返回卡信息字段;下單時傳了notifyUrl請等待開通成功後的回調通知,未傳可稍後查詢訂單詳情接口)


lpa - eSim配置(用於生成二維碼)

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">