Payment methods - merchant level

Update a payment method

Changed on

Updates payment method details for the merchant account and the payment method identified in the path. Depending the payment method type, you may need to send an additional object required for the payment method.

To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
patch/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

paymentMethodIdstring required

The unique identifier of the payment method.

Request body

countriesstring[]

The list of countries where a payment method is available. By default, all countries supported by the payment method.

currenciesstring[]

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.

customRoutingFlagsstring[]

Custom routing flags for acquirer routing.

enabledboolean

Indicates whether the payment method is enabled (true) or disabled (false).

storeIdstring

The store for this payment method

storeIdsstring[]

The list of stores for this payment method

Response

OK - the request has succeeded.

allowedboolean

Indicates whether receiving payments is allowed. This value is set to true by Adyen after screening your merchant account.

businessLineIdstring

The unique identifier of the business line. Required if you are a platform model.

countriesstring[]

The list of countries where a payment method is available. By default, all countries supported by the payment method.

currenciesstring[]

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.

customRoutingFlagsstring[]

The list of custom routing flags to route payment to the intended acquirer.

enabledboolean

Indicates whether the payment method is enabled (true) or disabled (false).

idstring required

The identifier of the resource.

merchantCategoryCodestring

The Merchant Category Code (MCC) associated with the payment method.

midstring

The Merchant Identifier (MID) associated with the payment method.

referencestring

Your reference for the payment method. Supported characters a-z, A-Z, 0-9.

shopperInteractionstring

The sales channel.

storeIdsstring[]

The unique identifier of the store for which to configure the payment method, if any.

typestring

Payment method variant.

For payment method variant cartebancaire, method-specific details are returned in the cartesBancaires object.

verificationStatus'valid' | 'pending' | 'invalid' | 'rejected'

Payment method status. Possible values:

  • valid
  • pending
  • invalid
  • rejected

Changes

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status