Sign in

v1

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

Creates a new payment manager in your Amazon Web Services account. A payment manager serves as the top-level resource for managing payment processing capabilities, including payment connectors that integrate with supported payment providers.

If you specify CUSTOM_JWT as the authorizerType, you must provide an authorizerConfiguration.

post/payments/managers

Request body

namestring required

The name of the payment manager.

descriptionstring

A description of the payment manager.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' required
<p>The type of authorizer to use for the payment manager.</p> <ul> <li> <p> <code>CUSTOM_JWT</code> - Authorize with a bearer token.</p> </li> <li> <p> <code>AWS_IAM</code> - Authorize with your Amazon Web Services IAM credentials.</p> </li> </ul>
roleArnstring required

The Amazon Resource Name (ARN) of the IAM role that the payment manager assumes to access resources on your behalf.

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>.

tagsobject

A map of tag keys and values to assign to the payment manager.

Response

Success

paymentManagerArnstring required

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

paymentManagerIdstring required

The unique identifier of the created payment manager.

namestring required

The name of the created payment manager.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' required

The type of authorizer for the created payment manager.

roleArnstring required

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

createdAtstring date-time required

The timestamp when the payment manager was created.

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

The current status of the 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>.

tagsobject

The tags associated with the created payment manager.