Get Payment Instrument

bedrockagentcore_get_payment_instrument

R Documentation

Get a payment instrument by ID

Description

Get a payment instrument by ID.

Usage

bedrockagentcore_get_payment_instrument(userId, agentName,
  paymentManagerArn, paymentConnectorId, paymentInstrumentId)

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	The ID of the payment connector.
paymentInstrumentId	[required] The ID of the payment instrument to retrieve.

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",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$get_payment_instrument(
  userId = "string",
  agentName = "string",
  paymentManagerArn = "string",
  paymentConnectorId = "string",
  paymentInstrumentId = "string"
)