Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Payments

Get Payment

To get payment method information by inputing payment method ID<br>輸入付款方式ID取得該付款方式資訊

get/payments/{id}

Path parameters

idstring required

Payment Method ID<br>付款方式ID

Query parameters

excludes[]string[]

Could exclude certain parameters in the response<br>結果要排除哪些參數

[
  "id"
]
fields[]string[]

Could only show certain parameters in the response<br>結果只顯示哪些參數

[
  "id"
]

Response

OK

idstring

Payment Method ID<br>付款方式ID

status'active' | 'draft'

Payment Method Status<br>付款方式狀態<br>-<br>Status allows:<br>active 啟用中<br><br>draft 隱藏

fee_percentnumber

Percentage of Payment Fee<br>附加費之百分比

fee_multipliernumber

Multiplier of Payment Fee<br>附加費之乘數<br>-<br>假設附加費設定為10%，則<br>fee_percent=10%<br><br>fee_multiplier=0.1

typestring

Payment's Type<br>付款方式代碼

excluded_delivery_option_idsstring[]

Excluded Delivery Option ID<br>該付款方式排除的送貨方式ID

binding_delivery_optionsstring[]

Binding delivery options codes<br>與該付款方式綁定的送貨方式代碼

is_sl_payment_availableboolean

Whether the payment is available or not<br>付款方式是否可用

show_description_on_checkoutboolean

Whether to display the payment description on checkout page<br>是否在結帳頁面顯示付款指示

Example response

{
  "id": "58d25b9d01cda3475300002d",
  "status": "active",
  "fee_percent": 10,
  "fee_multiplier": 0.1,
  "instructions_translations": {
    "en": "pay cash",
    "zh-hant": "現金付款"
  },
  "name_translations": {
    "en": "Cash",
    "zh-hant": "現金"
  },
  "config_data": {
    "shopline_payment_payment": "credit",
    "installments": [
      "3",
      "6"
    ],
    "payment_subtype": "credit"
  },
  "type": "paypal",
  "excluded_delivery_option_ids": [
    "5a7ab4a7e38809548f000009",
    "5a7ab407e38809548f000001"
  ],
  "binding_delivery_options": [
    "tw_711_pay"
  ],
  "is_sl_payment_available": true,
  "show_description_on_checkout": true
}