Update a payment method

patch /merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Updates payment method details for the merchant account and the payment method identified in the path.

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

  • Management API—Payment methods read and write

Endpoint destination URL

Click to copy

Path parameters

paymentMethodId string Required

The unique identifier of the payment method.

merchantId string Required

The unique identifier of the merchant account.

Request parameters

countries array [string]

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

currencies array [string]

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

customRoutingFlags array [string]

Custom routing flags for acquirer routing.

enabled boolean

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

shopperStatement object

Information regarding the shopper statement.

storeIds array [string]

The list of stores for this payment method

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less