Skip to content

Create a new payment instrument for a connector

Description

Create a new payment instrument for a connector.

Usage

bedrockagentcore_create_payment_instrument(userId, agentName,
  paymentManagerArn, paymentConnectorId, paymentInstrumentType,
  paymentInstrumentDetails, clientToken)

Arguments

  • userId

    The user ID associated with this payment instrument.

  • agentName

    The agent name associated with this request, used for observability.

  • paymentManagerArn

    [required] The ARN of the payment manager that owns this payment instrument.

  • paymentConnectorId

    [required] The ID of the payment connector to use for this instrument.

  • paymentInstrumentType

    [required] The type of payment instrument being created.

  • paymentInstrumentDetails

    [required] The details of the payment instrument.

  • clientToken

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Value

A list with the following syntax:

list(
  paymentInstrument = list(
    paymentInstrumentId = "string",
    paymentManagerArn = "string",
    paymentConnectorId = "string",
    userId = "string",
    paymentInstrumentType = "EMBEDDED_CRYPTO_WALLET",
    paymentInstrumentDetails = list(
      embeddedCryptoWallet = list(
        network = "ETHEREUM"|"SOLANA",
        linkedAccounts = list(
          list(
            email = list(
              emailAddress = "string"
            ),
            sms = list(
              phoneNumber = "string"
            ),
            developerJwt = list(
              kid = "string",
              sub = "string"
            ),
            oAuth2 = list(
              google = list(
                sub = "string",
                emailAddress = "string",
                name = "string",
                username = "string"
              ),
              apple = list(
                sub = "string",
                emailAddress = "string",
                name = "string",
                username = "string"
              ),
              x = list(
                sub = "string",
                emailAddress = "string",
                name = "string",
                username = "string"
              ),
              telegram = list(
                sub = "string",
                emailAddress = "string",
                name = "string",
                username = "string"
              ),
              github = list(
                sub = "string",
                emailAddress = "string",
                name = "string",
                username = "string"
              )
            )
          )
        ),
        walletAddress = "string",
        redirectUrl = "string"
      )
    ),
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    status = "INITIATED"|"ACTIVE"|"FAILED"|"DELETED"|"BLOCKED",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$create_payment_instrument(
  userId = "string",
  agentName = "string",
  paymentManagerArn = "string",
  paymentConnectorId = "string",
  paymentInstrumentType = "EMBEDDED_CRYPTO_WALLET",
  paymentInstrumentDetails = list(
    embeddedCryptoWallet = list(
      network = "ETHEREUM"|"SOLANA",
      linkedAccounts = list(
        list(
          email = list(
            emailAddress = "string"
          ),
          sms = list(
            phoneNumber = "string"
          ),
          developerJwt = list(
            kid = "string",
            sub = "string"
          ),
          oAuth2 = list(
            google = list(
              sub = "string",
              emailAddress = "string",
              name = "string",
              username = "string"
            ),
            apple = list(
              sub = "string",
              emailAddress = "string",
              name = "string",
              username = "string"
            ),
            x = list(
              sub = "string",
              emailAddress = "string",
              name = "string",
              username = "string"
            ),
            telegram = list(
              sub = "string",
              emailAddress = "string",
              name = "string",
              username = "string"
            ),
            github = list(
              sub = "string",
              emailAddress = "string",
              name = "string",
              username = "string"
            )
          )
        )
      ),
      walletAddress = "string",
      redirectUrl = "string"
    )
  ),
  clientToken = "string"
)