Get Payment options

Function

To get all kinds of payment methods with open API
透過open API獲取所有的付款方式

URL

GET <<api_domain>>/v1/payments

Request parameters

Parameter	Type	Description	Example
scope	`String`	payment methods in other channels 是否包含其他渠道的付款方式 - pos:包含實體商店付款方式 [注意] 如果沒開 SHOPLINE POS 的店家使用此參數會出現 error。	`pos`
per_page	`Integer`	Numbers of Payment Methods per Page 每頁顯示 n 筆資料 (Default: 24)	`ruby per_page: 24`
page	`Integer`	Page Number 頁數 (Default: 1)	`ruby page: 1`

Response Fields

Field	Type	Description	Example
items	Get Payment	Payments Data 付款方式資訊	Please check the link on the left
pagination	Pagination	Pagination Data 頁面資訊	Please check the link on the left

Response Example

{
    "items": [
        {
            "id": "58d25b9d01cda3475300002d",
            "status": "active",
            "fee_percent": 0,
            "fee_multiplier": 0,
            "instructions_translations": {
                "en": "pay cash",
                "zh-hant": "現金付款"
            },
            "name_translations": {
                "en": "Cash",
                "zh-hant": "現金"
            },
            "type": "custom",
            "excluded_delivery_option_ids": []
        },
        {
            "id": "58d25cd501cda3475300002e",
            "status": "active",
            "fee_percent": 0,
            "fee_multiplier": 0,
            "instructions_translations": {
                "en": "credit card",
                "zh-hant": "信用卡"
            },
            "name_translations": {
                "en": "credit card",
                "zh-hant": "信用卡"
            },
            "type": "pos_credit_card",
            "excluded_delivery_option_ids": []
        },
        {
            "id": "5a78377fe388096040000002",
            "status": "hidden",
            "fee_percent": 0,
            "fee_multiplier": 0,
            "instructions_translations": {},
            "name_translations": {
                "en": "Free Checkout",
                "zh-hant": "免費結帳"
            },
            "type": "free_checkout",
            "excluded_delivery_option_ids": []
        },
        {
            "id": "5a79605ce388090d10000011",
            "status": "active",
            "fee_percent": 0,
            "fee_multiplier": 0,
            "instructions_translations": {
                "zh-hant": "黑貓宅配(貨到付款)",
                "en": "黑貓宅配(貨到付款)"
            },
            "name_translations": {
                "zh-hant": "黑貓宅配(貨到付款)",
                "en": "黑貓宅配(貨到付款)"
            },
            "type": "tw_tcat_cod",
            "excluded_delivery_option_ids": []
        }
    ],
    "pagination": {
        "current_page": 1,
        "per_page": 24,
        "total_pages": 1,
        "total_count": 4
    }
}