BedrockAgentCoreControl / Client / create_payment_connector

create_payment_connector

BedrockAgentCoreControl.Client.create_payment_connector(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.create_payment_connector(
    paymentManagerId='string',
    name='string',
    description='string',
    type='CoinbaseCDP'|'StripePrivy',
    credentialProviderConfigurations=[
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            }
        },
    ],
    clientToken='string'
)

Parameters:

• paymentManagerId (string) –

  [REQUIRED]

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

• name (string) –

  [REQUIRED]

  The name of the payment connector.

• description (string) – A description of the payment connector.

• type (string) –

  [REQUIRED]

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

• credentialProviderConfigurations (list) –

  [REQUIRED]

  The credential provider configurations for the payment connector. These configurations specify how the connector authenticates with the payment provider.

  • (dict) –

    The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: coinbaseCDP, stripePrivy.

    • coinbaseCDP (dict) –

      The credential provider configuration for a Coinbase CDP payment connector.

      • credentialProviderArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

    • stripePrivy (dict) –

      The credential provider configuration for a Stripe Privy payment connector.

      • credentialProviderArn (string) – [REQUIRED]

        The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

• clientToken (string) –

  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.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'paymentConnectorId': 'string',
    'paymentManagerId': 'string',
    'name': 'string',
    'type': 'CoinbaseCDP'|'StripePrivy',
    'credentialProviderConfigurations': [
        {
            'coinbaseCDP': {
                'credentialProviderArn': 'string'
            },
            'stripePrivy': {
                'credentialProviderArn': 'string'
            }
        },
    ],
    'createdAt': datetime(2015, 1, 1),
    'status': 'CREATING'|'UPDATING'|'DELETING'|'READY'|'CREATE_FAILED'|'UPDATE_FAILED'|'DELETE_FAILED'
}

Response Structure

• (dict) –

  • paymentConnectorId (string) –

    The unique identifier of the created payment connector.

  • paymentManagerId (string) –

    The unique identifier of the parent payment manager.

  • name (string) –

    The name of the created payment connector.

  • type (string) –

    The type of the created payment connector.

  • credentialProviderConfigurations (list) –

    The credential provider configurations for the created payment connector.

    • (dict) –

      The credential provider configuration for a payment connector. Specifies the payment provider type and its associated credential provider.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: coinbaseCDP, stripePrivy. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      

      • coinbaseCDP (dict) –

        The credential provider configuration for a Coinbase CDP payment connector.

        • credentialProviderArn (string) –

          The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

      • stripePrivy (dict) –

        The credential provider configuration for a Stripe Privy payment connector.

        • credentialProviderArn (string) –

          The Amazon Resource Name (ARN) of the credential provider that stores the authentication credentials for the payment provider.

  • createdAt (datetime) –

    The timestamp when the payment connector was created.

  • status (string) –

    The current status of the payment connector. Possible values include CREATING, READY, UPDATING, DELETING, CREATE_FAILED, UPDATE_FAILED, and DELETE_FAILED.

Exceptions

• BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException

• BedrockAgentCoreControl.Client.exceptions.AccessDeniedException

• BedrockAgentCoreControl.Client.exceptions.ConflictException

• BedrockAgentCoreControl.Client.exceptions.ValidationException

• BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException

• BedrockAgentCoreControl.Client.exceptions.ThrottlingException

• BedrockAgentCoreControl.Client.exceptions.InternalServerException