Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

RotatePaymentConnectorCredentials

Replaces the service-managed credentials of a payment connector with newly issued credentials.

Use this operation only for payment connectors with a provisionMode of QUICK_CREATE. For payment connectors with a provisionMode of MANUAL, call UpdatePaymentCredentialProvider instead after rotating credentials with the payment provider directly.

The rotation finishes before the response is returned, and only one rotation runs at a time for a given payment connector. When it succeeds, the new credential is in effect and the payment connector stays in the READY state. When it fails, an error is returned, the payment connector and its existing credential are left unchanged, and you can retry the request.

Rotation replaces the credential on the connector's credential provider, so every payment connector that uses that provider is affected. Replace any copy of the previous credential that you use outside AgentCore.

Request Syntax


POST /payments/managers/paymentManagerId/connectors/paymentConnectorId/rotate-credentials HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "credentialsToRotate": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

paymentConnectorId

The unique identifier of the payment connector whose credentials you want to rotate.

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z_][-]?){1,100}-[0-9a-z]{10}

Required: Yes

paymentManagerId

The unique identifier of the parent payment manager.

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientToken

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

Type: String

Length Constraints: Minimum length of 33. Maximum length of 256.

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

credentialsToRotate

The credentials to rotate. Specify the member that matches the payment connector's type. Each credential that you select is rotated independently.

Type: CredentialRotationConfig object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 202
Content-type: application/json

{
   "lastUpdatedAt": "string",
   "paymentConnectorId": "string",
   "paymentManagerId": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 202 response.

The following data is returned in JSON format by the service.

lastUpdatedAt

The timestamp when the payment connector was last updated, which is when the rotation completed.

Type: Timestamp

paymentConnectorId

The unique identifier of the payment connector.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z_][-]?){1,100}-[0-9a-z]{10}

paymentManagerId

The unique identifier of the parent payment manager.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

status

The current status of the payment connector, which is READY after a successful rotation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

This exception is thrown when a request is denied per access permissions

HTTP Status Code: 403

ConflictException

This exception is thrown when there is a conflict performing an operation

HTTP Status Code: 409

InternalServerException

This exception is thrown if there was an unexpected error during processing of request

HTTP Status Code: 500

ResourceNotFoundException

This exception is thrown when a resource referenced by the operation does not exist

HTTP Status Code: 404

ThrottlingException

This exception is thrown when the number of requests exceeds the limit

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

HTTP Status Code: 400