Sign in

v1

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

Creates a new payment connector for a payment manager. A payment connector integrates with a supported payment provider to enable payment processing capabilities.

post/payments/managers/{paymentManagerId}/connectors

Path parameters

paymentManagerIdstring required

The unique identifier of the payment manager to create the connector for.

Request body

namestring required

The name of the payment connector.

descriptionstring

A description of the payment connector.

type'CoinbaseCDP' | 'StripePrivy' required

The type of payment connector, which determines the payment provider integration.

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 created payment connector.

paymentManagerIdstring required

The unique identifier of the parent payment manager.

namestring required

The name of the created payment connector.

type'CoinbaseCDP' | 'StripePrivy' required

The type of the created payment connector.

createdAtstring date-time required

The timestamp when the payment connector was created.

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

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