Skip to main content

建立退款交易

介面路徑​

請求方式API 路徑
POST{DOMAIN_NAME} /api/v1/trade/refund/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 電文​

referenceOrderIdString(32)必填
特店退款訂單號
tradeOrderIdString(32)必填
SLP 付款交易訂單編號
reasonString(256)選填
退款原因
additionalDataMap選填
附加資訊

回應電文​

處理結果 http.statusCode​

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

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

* 200：處理成功​

refundOrderIdString(32)必填
SLP 退款訂單號
referenceOrderIdString(32)必填
特店退款訂單號
tradeOrderIdString(32)必填
SLP 付款交易訂單編號
statusString(6)必填參考
退款狀態
POST/api/v1/trade/refund/create

sandbox api

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

live api

https://api.shoplinepayments.com/api/v1/trade/refund/create
請求電文範例
<?php
$url = 'https://api-sandbox.shoplinepayments.com/api/v1/trade/refund/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 = [
    "referenceOrderId" => $referenceId,
    "tradeOrderId" => "165165165165165633",
    "amount" => [
        "value" => 100,
        "currency" => "TWD"
    ],
    "reason" => "test"
];

$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);
回應電文範例
{
  "referenceRefundOrderId": "ref_refund_ORDERID-123455677889990",
  "tradeOrderId": "165165165165165633",
  "refundOrderId": "45668468546465",
  "amount": {
    "value": 100000,
    "currency": "TWD"
  },
  "status": "SUCCEEDED"
}