---
title: "Configure cascading payment methods for an account"
method: PUT
path: "/v1/accounts/{account-key}/payment-methods/cascading"
tags: ["Accounts"]
---

# Configure cascading payment methods for an account

`PUT /v1/accounts/{account-key}/payment-methods/cascading`

Zuora provides the Cascading Payment Method feature to dynamically retry the failed payment with alternative payment methods according to a predefined priority list. Use this API operation to configure the cascading consent for a specified account and set up the priority list of payment methods to be used in Cascading Payment Method.

Before you use this API operation, ensure that the Cascading Payment Method feature is enabled. For more information about the Cascading Payment Method feature, see <a href="https://docs.zuora.com?resourceId=payments-cascade-payment-methods" target="_blank">Cascade payment methods</a>.

## Path parameters

- `account-key` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Org-Ids` string
- `Zuora-Version` string

## Request body

- PutCascadingPaymentMethodsConfigurationRequest
  - `consent` boolean — `true` indicates that you have collected consent from your customer to use the Cascading Payment Method feature. `false` indicates the consent was not collected and the Cascading Payment Method feature is not enabled. The `priorities` field can be specified only if `consent` is `true`.
  - `priorities` object[] — Container for the priority configuration of payment methods. You can add up to three payment methods to this container. For more information, see <a href="https://docs.zuora.com?resourceId=payments-cascade-payment-methods" target="_blank">Cascade payment methods</a>. `priorities` is required if `consent` is `true`.
    - `paymentMethodId` string, required — The ID of a payment method.
    - `order` integer, required — The order of the payment method in the priority list. For example, `1` indicates the payment method is the first one in the priority list, and `2` indicates it is the second. The first payment method in the priority list will be the default payment method of the customer account.

## Response `200`

OK

- CommonResponse
  - `processId` string — The ID of the process that handles the operation.
  - `reasons` object[] — The container of the error code and message. This field is available only if the `success` field is `false`.
    - `code` string — The error code of response.
    - `message` string — The detail information of the error response
  - `requestId` string, uuid — Unique identifier of the request.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)