---
title: "Get Payment"
method: GET
path: "/payments/{id}"
tags: ["Payments"]
---

# Get Payment

`GET /payments/{id}`

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

## Path parameters

- `id` string, required

## Query parameters

- `excludes[]` string[]
- `fields[]` string[]

## Response `200`

OK

- Payment
  - `id` string — Payment Method ID<br>付款方式ID
  - `status` 'active' | 'draft' — Payment Method Status<br>付款方式狀態<br>-<br>Status allows:<br>active 啟用中<br><br>draft 隱藏
  - `fee_percent` number — Percentage of Payment Fee<br>附加費之百分比
  - `fee_multiplier` number — Multiplier of Payment Fee<br>附加費之乘數<br>-<br>假設附加費設定為10%，則<br>fee_percent=10%<br><br>fee_multiplier=0.1
  - `instructions_translations` object — Payment Instructions<br>付款指示
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `name_translations` object — Payment Method Name<br>付款方式名稱
    - `en` string — Merchant defined English name<br>店家定義英文名稱
    - `zh-hant` string — Merchant defined Traditional Chinese name<br>店家定義繁體中文名稱
    - `zh-cn` string — Merchant defined Simplified Chinese name<br>店家定義簡體中文名稱
    - `vi` string — Merchant defined Vietnamese name<br>店家定義越南文名稱
    - `ms` string — Merchant defined Malaysian name<br>店家定義馬來西亞文名稱
    - `ja` string — Merchant defined Japanese name<br>店家定義日文名稱
    - `th` string — Merchant defined Thai name<br>店家定義泰文名稱
    - `id` string — Merchant defined Indian name<br>店家定義印度文名稱
    - `de` string — Merchant defined Deutsch name<br>店家定義德文名稱
    - `fr` string — Merchant defined France name<br>店家定義法文名稱
  - `config_data` object — Payment Config Data<br>付款相關資料
    - `shopline_payment_payment` 'credit' | 'specific_credit_types' — Shopline payment type<br>Shopline payment 支援的付款方式
    - `installments` string[] — Installments<br>分期可選期數
    - `payment_subtype` string — Payment Subtype<br>付款子類型
  - `type` string — Payment's Type<br>付款方式代碼
  - `excluded_delivery_option_ids` string[] — Excluded Delivery Option ID<br>該付款方式排除的送貨方式ID
  - `binding_delivery_options` string[] — Binding delivery options codes<br>與該付款方式綁定的送貨方式代碼
  - `is_sl_payment_available` boolean — Whether the payment is available or not<br>付款方式是否可用
  - `show_description_on_checkout` boolean — Whether to display the payment description on checkout page<br>是否在結帳頁面顯示付款指示

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/revisions/1675ac12cde7/schema)
