HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Get Payment option

Function

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

URL

GET <<api_domain>>/v1/payments/:id

Request parameters

ParameterTypeDescriptionExample
id
*Required
StringPayment Method ID
付款方式ID
ruby 58d25b9d01cda3475300002d

Response fields

FieldTypeDescriptionExample
idStringPayment Method ID
付款方式ID
58d25b9d01cda3475300002d
statusStringPayment Method Status
付款方式狀態
-
Status allows:
active 啟用中

draft 隱藏
active
fee_percentFloatPercentage of Payment Fee
附加費之百分比
10
fee_multiplierFloatMultiplier of Payment Fee
附加費之乘數
-
假設附加費設定為10%,則
fee_percent=10%

fee_multiplier=0.1
0.1
instructions_translationsTranslationPayment Instructions
付款指示
"en": "pay cash",
"zh-hant": "現金付款"
name_translationsTranslationPayment Method Name
付款方式名稱
"en": "Cash",
"zh-hant": "現金"
typeStringPayment's Type
付款方式代碼
paypal
excluded_delivery_option_idsArrayExcluded Delivery Option ID
該付款方式排除的送貨方式ID
5a7ab4a7e38809548f000009,
5a7ab407e38809548f000001

Response Example

{
    "id": "58d25b9d01cda3475300002d",
    "status": "active",
    "fee_percent": 10,
    "fee_multiplier": 0.1,
    "instructions_translations": {
        "en": "pay cash",
        "zh-hant": "現金付款"
    },
    "name_translations": {
        "en": "Cash",
        "zh-hant": "現金"
    },
    "type": "custom",
    "excluded_delivery_option_ids": [
        "5a7ab4a7e38809548f000009",
        "5a7ab407e38809548f000001"
    ]
}