Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Payments

Get Payments

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

get/payments

Query parameters

pageinteger

Page Number<br>頁數

per_pageinteger

Numbers of Orders per Page<br>每頁顯示 n 筆資料

sort_by'asc' | 'desc'

Setting sorting direction<br>設定時間排序

order_by'created_at' | 'priority'

Setting sorting attribute<br>設定排序使用值

updated_afterstring

Filter payments by those updated after specific time.<br>取得 updated_at 大於指定時間的付款方式(包含指定時間)<br> *Should use UTC time'

updated_beforestring

Filter payments by those updated before specific time.<br>取得 updated_at 小於指定時間的付款方式(包含指定時間)<br> *Should use UTC time'

excludes[]string[]

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

[
  "items.id"
]
fields[]string[]

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

[
  "items.id"
]
channel_idstring

Filter payments by channel approved sl-payments methods.<br>取得門店可用付款方式

Response

OK

Example response

{
  "items": [
    {
      "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
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 24,
    "total_count": 1,
    "total_pages": 1
  }
}