Payment Methods

Update Payment Method

Changed on

Updates a payment method.

put/v1/shops/{shopId}/payment-methods/{paymentMethodId}

Request

Request body

type'CUSTOMERBALANCE' | 'BTC' | 'LTC' | 'ETH' | 'ETH_USDT' | 'ETH_USDC' | 'SOL' | 'SOL_USDT' | 'SOL_USDC' | 'PAYPAL' | 'STRIPE' | 'SQUARE' | 'CASHAPP' | 'VENMO' | 'ZELLE' | 'REWARBLE' | 'PAYPALFF' | 'AMAZONPS' | 'SUMUP' | 'MOLLIE' | 'SKRILL' | 'SKRILLP2P' | 'AUTHORIZENET' | 'REVOLUTBUSINESS' | 'LEMONSQUEEZY' | 'NMI' | 'OVERPAY' | 'MONEI' | 'RAZORPAY' | 'MERCADOPAGO' | 'PANDABASE' | 'VENPAYR' | 'MISTICPAY' | 'OVGC' | 'WHOP' | 'DODOPAYMENTS' | 'PAYMONGO' | 'SHOPIFY' | 'MANUAL' required
namestring required

Must not be greater than 100 characters.

checkout_namestring nullable

Must not be greater than 100 characters.

icon_image_idinteger nullable

Must match an existing stored value.

labelstring nullable

Must not be greater than 100 characters.

fixed_feenumber nullable

Must be at least -100. Must not be greater than 100.

percentage_feenumber nullable

Must be at least -50. Must not be greater than 50.

min_amountnumber nullable

Must be at least 0. Must not be greater than 999999.

max_amountnumber nullable

Must be at least 0. Must not be greater than 999999.

currency_overridestring nullable

Must not be greater than 3 characters.

hide_powered_byboolean nullable
is_activeboolean nullable
settingsobject nullable
passwordstring nullable

Must not be greater than 255 characters.

otpstring nullable

Must not be greater than 6 characters.

tfa_codestring nullable

Must not be greater than 8 characters.

remember_mfaboolean nullable

Example request

{
  "type": "MISTICPAY",
  "name": "tjqotbhpzwonwlzospqcs",
  "checkout_name": "nssrciatkmatldznkaapj",
  "icon_image_id": 6,
  "label": "jqotbhpzwonwlzospqcsn",
  "fixed_fee": 22,
  "percentage_fee": 5,
  "min_amount": 24,
  "max_amount": 2,
  "currency_override": "ia",
  "is_active": true,
  "password": "Ie%pZx<Fwu_8tJ\\hz[DJ",
  "otp": "ma",
  "tfa_code": "rwuvlv",
  "remember_mfa": true
}

Changes

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became nullable

    • breaking

      removed the enum value ADYEN of the request property