POportone
MasterMerchant APIs

Update Payment Method Status

post/api/master-merchant/{mkey}/merchants/payment-methods

Request

  • Base URL
    https://api.portone.cloud
  • URL
    https://api.portone.cloud/api/master-merchant/{mkey}/merchants/payment-methods
  • Auth
    none declared

Path parameters

mkeystring required

Headers

X-Portone-Client-Keystring
Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

payment_channel_keystring required

The Payment Channel Key listed in PortOne docs

payment_method_keystring required

The Payment Method Key listed in PortOne docs

enablestring required

The boolean indicating whether to enable or disable the Payment Method

defaultstring required

The boolean indicating whether to mark the Payment Method as default

action_typestring required

The action_type. either UPDATE_ENABLE_STATUS or UPDATE_DEFAULT_STATUS

method_sub_typestring required

The payment method sub_type. either WALLET or INT_CARD

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

Example request

{
  "merchants_keys": [
    "MtvGCfbhgjSpkdct"
  ],
  "payment_channel_key": "MOMOPAY",
  "payment_method_key": "MOMOPAY_WALLET",
  "enable": true,
  "default": true,
  "action_type": "UPDATE_ENABLE_STATUS",
  "method_sub_type": "WALLET",
  "environment": "sandbox"
}

Response

Successful response

messagestring

The description of the API request execution result

status_codestring

The status_code for API request execution result

status_reasonstring

The status_reason for API request execution result

Changes

No recorded changes to this operation across all 1 revision of this API.