Skip to main content

建立結帳交易

介面路徑​

請求方式API 路徑
POST{DOMAIN_NAME} /api/v1/trade/sessions/create

請求電文​

Http.header 參數​

Content-TypeString必填
固定值：application/json
platformIdString選填
SLP 平台 ID，平台特店必填
merchantIdString必填
直連特店串接：SLP 分配的特店 ID；平台特店串接：SLP 分配的子特店 ID
apiKeyString必填
API 介面金鑰
requestIdString(32)必填
請求流水號，每個 HTTP 請求唯一
idempotentKeyString(32)選填
冪等 KEY

Http.body 封包​

referenceIdString(32)必填
特店訂單號
languageString(6)選填參考
語言
expireTimeInteger選填
設定結帳交易的逾時時間，若不設定則默认為 360, 單位：min
returnUrlString(256)必填
顧客付款完成之後回到特店的頁面
modeString必填
固定填：regular
allowPaymentMethodList[]String必填參考
設定 SessionURL 上可以使用的付款方式，陣列的順序為實際在 Session URL 顯示的付款方式順序。傳入範例：["CreditCard", "ApplePay", "VirtualAccount"]

回應電文​

處理結果 http.statusCode​

* 500 /429 /400：處理異常​

codeString必填
錯誤碼，錯誤碼及錯誤描述詳情查看： Server 錯誤碼
msgString必填
錯誤描述，錯誤碼及錯誤描述詳情查看： Server 錯誤碼

* 200：處理成功​

sessionIdString(32)必填
SLP 結帳交易訂單編號
referenceIdString(32)必填
特店訂單號
statusString(16)必填參考
結帳交易狀態
sessionUrlString(256)必填
結帳交易提供給顧客付款的 URL
createTimeInteger必填
訂單建立時間
POST/api/v1/trade/sessions/create

sandbox api

https://api-sandbox.shoplinepayments.com/api/v1/trade/sessions/create

live api

https://api.shoplinepayments.com/api/v1/trade/sessions/create
請求電文範例
<?php
$url = 'https://api-sandbox.shoplinepayments.com/api/v1/trade/sessions/create';

// 動態 requestId 與 referenceId
$referenceId = uniqid();
$requestId = uniqid();

// 正確格式的 headers 陣列
$headers = [
    "Content-Type: application/json",
    "merchantId: <YOUR-MERCHANT-ID>",
    "apiKey: <YOUR-API-KEY>",
    "requestId: $requestId"
];

// 正確格式的 Request Data
$data = [
    "referenceId" => $referenceId,
    "language" => "en",
    "amount" => [
        "value" => 100,
        "currency" => "TWD"
    ],
    "expireTime" => 60,
    "returnUrl" => "https://your-domain.com/return",
    "mode" => "regular",
    "allowPaymentMethodList" => [
        "CreditCard",
        "ApplePay",
        "ChaileaseBNPL",
        "VirtualAccount",
        "JKOPay"
    ],
    "paymentMethodOptions" => [
        "CreditCard" => [
            "installmentCounts" => ["0","3","6","9","12"]
        ],
        "ChaileaseBNPL" => [
            "installmentCounts" => ["0","3","6","9","12"],
            "paymentExpireTime" => 120
        ],
        "VirtualAccount" => [
            "paymentExpireTime" => 120
        ],
        "JKOPay" => [
            "paymentExpireTime" => 120
        ],
    ],
    "order" => [
        "products" => [[
            "id" => "650815fd2a17ae0017f2d360",
            "name" => "ROYALPRO全分離乳清蛋白-綜合口味30入",
            "quantity" => 1,
            "amount" => [
                "value" => 100000,
                "currency" => "TWD"
            ],
            "sku" => "4329325836183615218",
            "desc" => "ROYALPRO全分離乳清蛋白-綜合口味30入",
            "url" => "https://www.shoplinepayments.com/product/4329325836183615218"
        ]],
        "shipping" => [
            "shippingMethod" => "宅配",
            "carrier" => "黑貓宅配",
            "personalInfo" => [
                "firstName" => "三",
                "lastName" => "張",
                "email" => "zhangsan@gmail.com",
                "phone" => "+8860287682010"
            ],
            "address" => [
                "countryCode" => "TW",
                "stateCode" => "",
                "state" => "",
                "city" => "台北市",
                "district" => "松山區",
                "street" => "敦化北路170號10樓 A室",
                "postcode" => "105405"
            ]
        ]
    ],
    "customer" => [
        "referenceCustomerId" => "referenceCustomerId",
        "type" => "0",
        "personalInfo" => [
            "firstName" => "三",
            "lastName" => "張",
            "email" => "zhangsan@gmail.com",
            "phone" => "+8860287682010"
        ]
    ],
    "billing" => [
        "personalInfo" => [
            "firstName" => "三",
            "lastName" => "張",
            "email" => "zhangsan@gmail.com",
            "phone" => "+8860287682010"
        ],
        "address" => [
            "countryCode" => "TW",
            "stateCode" => "",
            "state" => "",
            "city" => "台北市",
            "district" => "松山區",
            "street" => "敦化北路170號10樓 A室",
            "postcode" => "105405"
        ]
    ],
    "client" => [
        "ip" => "127.0.0.1",
    ],
];

print_r($data);
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => $headers
]);

$response = curl_exec($curl);
$httpCode = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

// 回覆結果處理
$result = json_decode($response, true);
echo "HTTP Code: $httpCode";
print_r($result);
回應電文範例
{
  "sessionId": "se_01022502286885089464780754095",
  "referenceId": "ORDERID-123455677889990",
  "status": "CREATED",
  "amount": {
    "value": 100000,
    "currency": "TWD"
  },
  "sessionUrl": "https://api-sandbox.shoplinepayments.com/checkout/session?sessionToken=xxxx",
  "createTime": "1740711420842"
}