Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141531,219979.8 KB

Updates an existing payment manager. This operation uses PATCH semantics, so you only need to specify the fields you want to change.

patch/payments/managers/{paymentManagerId}

Path parameters

paymentManagerIdstring required

The unique identifier of the payment manager to update.

Request body

descriptionstring

The updated description of the payment manager.

authorizerType'CUSTOM_JWT' | 'AWS_IAM'

The updated authorizer type for the payment manager.

roleArnstring

The updated Amazon Resource Name (ARN) of the IAM role for the payment manager.

clientTokenstring

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensuring idempotency</a>.

Response

Success

paymentManagerArnstring required

The Amazon Resource Name (ARN) of the updated payment manager.

paymentManagerIdstring required

The unique identifier of the updated payment manager.

namestring required

The name of the updated payment manager.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' required

The type of authorizer for the updated payment manager.

roleArnstring required

The Amazon Resource Name (ARN) of the IAM role associated with the updated payment manager.

lastUpdatedAtstring date-time required

The timestamp when the payment manager was last updated.

status'CREATING' | 'UPDATING' | 'DELETING' | 'READY' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED' required

The current status of the updated payment manager. Possible values include <code>CREATING</code>, <code>READY</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>CREATE_FAILED</code>, <code>UPDATE_FAILED</code>, and <code>DELETE_FAILED</code>.