Patch paymentsmanagerspaymentmanageridconnectorspaymentconnectorid

v1

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

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

patch/payments/managers/{paymentManagerId}/connectors/{paymentConnectorId}

Path parameters

paymentManagerIdstring required

The unique identifier of the parent payment manager.

paymentConnectorIdstring required

The unique identifier of the payment connector to update.

Request body

descriptionstring

The updated description of the payment connector.

type'CoinbaseCDP' | 'StripePrivy'

The updated type of the payment connector.

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

paymentConnectorIdstring required

The unique identifier of the updated payment connector.

paymentManagerIdstring required

The unique identifier of the parent payment manager.

namestring required

The name of the updated payment connector.

type'CoinbaseCDP' | 'StripePrivy' required

The type of the updated payment connector.

lastUpdatedAtstring date-time required

The timestamp when the payment connector was last updated.

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