eSim購買

為方便開發調試，我們提供測試接口用於餘額支付調試。測試接口返回的均為模擬數據（sn、lpa、iccid、號碼、驗證碼等均為隨機/固定樣例），不會實際扣除餘額、不會生成真實訂單、不會佔用庫存，也不會發送真實 eSIM 或觸發回調通知。實際部署務必使用正式接口。

測試接口：https://api.bigesim.com/api/payTest

正式接口：https://api.bigesim.com/api/pay

請求接口

POST GET

請求頭部（Headers）

字段名	字段值	操作
+ 添加字段

請求參數（Params）

字段名	字段值	操作
+ 添加字段

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