v1

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

Retrieves information about a specific payment manager.

get/payments/managers/{paymentManagerId}

Path parameters

paymentManagerIdstring required

The unique identifier of the payment manager to retrieve.

Response

Success

paymentManagerArnstring required

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

paymentManagerIdstring required

The unique identifier of the payment manager.

namestring required

The name of the payment manager.

descriptionstring

The description of the payment manager.

authorizerType'CUSTOM_JWT' | 'AWS_IAM' required
<p>The type of authorizer used by 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 associated with the payment manager.

createdAtstring date-time required

The timestamp when the payment manager was created.

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