BedrockAgentCoreControl / Client / create_payment_credential_provider

create_payment_credential_provider¶

BedrockAgentCoreControl.Client.create_payment_credential_provider(**kwargs)¶

Creates a new payment credential provider for storing authentication credentials used by payment connectors to communicate with external payment providers.

Request Syntax

response = client.create_payment_credential_provider(
    name='string',
    credentialProviderVendor='CoinbaseCDP'|'StripePrivy',
    providerConfigurationInput={
        'coinbaseCdpConfiguration': {
            'apiKeyId': 'string',
            'apiKeySecret': 'string',
            'walletSecret': 'string'
        },
        'stripePrivyConfiguration': {
            'appId': 'string',
            'appSecret': 'string',
            'authorizationPrivateKey': 'string',
            'authorizationId': 'string'
        }
    },
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

Unique name for the payment credential provider.
credentialProviderVendor (string) –
[REQUIRED]

The vendor type for the payment credential provider (e.g., CoinbaseCDP, StripePrivy).
providerConfigurationInput (dict) –
[REQUIRED]

Configuration specific to the vendor, including API credentials.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: coinbaseCdpConfiguration, stripePrivyConfiguration.
- coinbaseCdpConfiguration (dict) –
  
  The Coinbase CDP configuration.
  - apiKeyId (string) – [REQUIRED]
    
    The API key identifier provided by Coinbase Developer Platform.
  - apiKeySecret (string) – [REQUIRED]
    
    The API key secret provided by Coinbase Developer Platform.
  - walletSecret (string) – [REQUIRED]
    
    The wallet secret provided by Coinbase Developer Platform.
- stripePrivyConfiguration (dict) –
  
  The Stripe Privy configuration.
  - appId (string) – [REQUIRED]
    
    The app ID provided by Privy.
  - appSecret (string) – [REQUIRED]
    
    The app secret provided by Privy.
  - authorizationPrivateKey (string) – [REQUIRED]
    
    The authorization private key for the Stripe Privy integration.
  - authorizationId (string) – [REQUIRED]
    
    The authorization ID for the Stripe Privy integration.
tags (dict) –
Optional tags for resource organization.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'name': 'string',
    'credentialProviderVendor': 'CoinbaseCDP'|'StripePrivy',
    'credentialProviderArn': 'string',
    'providerConfigurationOutput': {
        'coinbaseCdpConfiguration': {
            'apiKeyId': 'string',
            'apiKeySecretArn': {
                'secretArn': 'string'
            },
            'walletSecretArn': {
                'secretArn': 'string'
            }
        },
        'stripePrivyConfiguration': {
            'appId': 'string',
            'appSecretArn': {
                'secretArn': 'string'
            },
            'authorizationPrivateKeyArn': {
                'secretArn': 'string'
            },
            'authorizationId': 'string'
        }
    }
}

Response Structure

(dict) –
- name (string) –
  
  The name of the created payment credential provider.
- credentialProviderVendor (string) –
  
  The vendor type for the created payment credential provider.
- credentialProviderArn (string) –
  
  The Amazon Resource Name (ARN) of the created payment credential provider.
- providerConfigurationOutput (dict) –
  
  Output configuration (contains secret ARNs, excludes actual secret values).
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: coinbaseCdpConfiguration, stripePrivyConfiguration. 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'}
  - coinbaseCdpConfiguration (dict) –
    
    The Coinbase CDP configuration.
    - apiKeyId (string) –
      
      The API key identifier provided by Coinbase Developer Platform.
    - apiKeySecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - walletSecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
  - stripePrivyConfiguration (dict) –
    
    The Stripe Privy configuration.
    - appId (string) –
      
      The app ID provided by Privy.
    - appSecretArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - authorizationPrivateKeyArn (dict) –
      
      Contains information about a secret in AWS Secrets Manager.
      - secretArn (string) –
        
        The Amazon Resource Name (ARN) of the secret in AWS Secrets Manager.
    - authorizationId (string) –
      
      The authorization ID for the Stripe Privy integration.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControl.Client.exceptions.UnauthorizedException
BedrockAgentCoreControl.Client.exceptions.ResourceLimitExceededException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.DecryptionFailure
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException
BedrockAgentCoreControl.Client.exceptions.EncryptionFailure