Skip to main content

付款工具列表查詢

介面路徑​

請求方式API 路徑
POST{DOMAIN_NAME} /api/v1/customer/paymentInstrument/query

請求電文​

Http.header 參數​

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

Http.body​

customerIdString必填
會員 ID

回應電文​

處理結果 http.statusCode​

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

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

* 200：處理成功​

customerIdString(32)必填
SLP 會員 ID
referenceCustomerIdString(32)必填
特店顧客唯一標識
additionalDataMap選填
附加資訊
passthroughString選填
透傳資訊
POST/api/v1/customer/paymentInstrument/query

sandbox api

https://api-sandbox.shoplinepayments.com/api/v1/customer/paymentInstrument/query

live api

https://api.shoplinepayments.com/api/v1/customer/paymentInstrument/query
請求電文範例
{
  "customerId":"10182210081665221019441020200",//String(64)/必填/SLP 會員 ID
  "paymentInstrument":{
    "instrumentId":"20002210091665281094739020300",//指定 ID 查詢
    "instrumentType":"CreditCard",//指定付款工具類型查詢
    "instrumentStatus":"",//指定付款工具狀態查詢，與 instrumentStatusList 二選一,兩者同時存在 instrumentStatus
    "instrumentStatusList":["CREATED","SUCCESSED"] //指定多種付款工具狀態查詢，與 instrumentStatus 二選一
  }
}
回應電文範例
{
  "customerId": "10182210081665221019441020200",
  "referenceCustomerId": "1665200960531",
  "paymentInstruments": [
    {
      "instrumentId": "20002210091665281094739020300",
      "instrumentType": "CreditCard",
      "instrumentStatus": "ENABLED",
      "instrumentCard": {
        "type": "DEBIT",
        "brand": "Mastercard",
        "expireYear": "2025",
        "expireMonth": "8",
        "holder": "257",
        "first": "543603",
        "last": "6378",
        "issuer": "SBM BANK (MAURITIUS) LTD",
        "issuerCountry": "MU",
        "expired": false
      }
    }
  ]
}