payment_instruments

Creates, updates, deletes, gets or lists a payment_instruments resource.

Overview

Name	`payment_instruments`
Type	Resource
Id	`aws.bedrock_agentcore.payment_instruments`

Fields

The following fields are returned by SELECT queries:

get_payment_instrument
list_payment_instruments

Name	Datatype	Description
`created_at`	`string (date-time)`	The timestamp when this payment instrument was created.
`payment_connector_id`	`string`	The ID of the payment connector associated with this instrument. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
`payment_instrument_details`	`object`	Details specific to the instrument type.
`payment_instrument_id`	`string`	The unique identifier for this payment instrument. (pattern: <code>payment-instrument-[0-9a-zA-Z-]{15}</code>)
`payment_instrument_type`	`string`	The type of payment instrument. (EMBEDDED_CRYPTO_WALLET)
`payment_manager_arn`	`string`	The ARN of the payment manager that owns this payment instrument. (pattern: <code>arn:(aws\|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}</code>)
`status`	`string`	The current status of this payment instrument. (INITIATED, ACTIVE, FAILED, DELETED, BLOCKED)
`updated_at`	`string (date-time)`	The timestamp when this payment instrument was last updated.
`user_id`	`string`	The user ID associated with this payment instrument.

Name	Datatype	Description
`created_at`	`string (date-time)`	The timestamp when this payment instrument was created.
`payment_connector_id`	`string`	The ID of the payment connector associated with this instrument. (pattern: <code>([0-9a-z][-]?){1,100}-[0-9a-z]{10}</code>)
`payment_instrument_id`	`string`	The unique identifier for this payment instrument. (pattern: <code>payment-instrument-[0-9a-zA-Z-]{15}</code>)
`payment_instrument_type`	`string`	The type of payment instrument. (EMBEDDED_CRYPTO_WALLET)
`payment_manager_arn`	`string`	The ARN of the payment manager that owns this payment instrument. (pattern: <code>arn:(aws\|aws-[a-z0-9-]+):bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:payment-manager/[a-z0-9]([a-z0-9-]{0,47}[a-z0-9])?-[a-z0-9]{10}</code>)
`status`	`string`	The current status of this payment instrument. (INITIATED, ACTIVE, FAILED, DELETED, BLOCKED)
`updated_at`	`string (date-time)`	The timestamp when this payment instrument was last updated.
`user_id`	`string`	The user ID associated with this payment instrument.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_payment_instrument`	`select`	`region`	`X-Amzn-Bedrock-AgentCore-Payments-User-Id`, `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`	Get a payment instrument by ID.
`list_payment_instruments`	`select`	`region`	`X-Amzn-Bedrock-AgentCore-Payments-User-Id`, `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`	List payment instruments for a manager.
`create_payment_instrument`	`insert`	`region`, `paymentManagerArn`, `paymentConnectorId`, `paymentInstrumentType`, `paymentInstrumentDetails`	`X-Amzn-Bedrock-AgentCore-Payments-User-Id`, `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`	Create a new payment instrument for a connector.
`delete_payment_instrument`	`delete`	`region`	`X-Amzn-Bedrock-AgentCore-Payments-User-Id`	Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.
`process_payment`	`exec`	`region`, `paymentManagerArn`, `paymentSessionId`, `paymentInstrumentId`, `paymentType`, `paymentInput`	`X-Amzn-Bedrock-AgentCore-Payments-User-Id`, `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`	Processes a payment using a payment instrument within a payment session.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`region`	`string`	AWS region (default: us-east-1)
`X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`	`string`	The agent name associated with this request, used for observability.
`X-Amzn-Bedrock-AgentCore-Payments-User-Id`	`string`	The user ID associated with this payment.

`SELECT` examples

get_payment_instrument
list_payment_instruments

Get a payment instrument by ID.

SELECT
created_at,
payment_connector_id,
payment_instrument_details,
payment_instrument_id,
payment_instrument_type,
payment_manager_arn,
status,
updated_at,
user_id
FROM aws.bedrock_agentcore.payment_instruments
WHERE region = '{{ region }}' -- required
AND `X-Amzn-Bedrock-AgentCore-Payments-User-Id` = '{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}'
AND `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name` = '{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}'
;

List payment instruments for a manager.

SELECT
created_at,
payment_connector_id,
payment_instrument_id,
payment_instrument_type,
payment_manager_arn,
status,
updated_at,
user_id
FROM aws.bedrock_agentcore.payment_instruments
WHERE region = '{{ region }}' -- required
AND `X-Amzn-Bedrock-AgentCore-Payments-User-Id` = '{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}'
AND `X-Amzn-Bedrock-AgentCore-Payments-Agent-Name` = '{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}'
;

`INSERT` examples

create_payment_instrument
Manifest

Create a new payment instrument for a connector.

INSERT INTO aws.bedrock_agentcore.payment_instruments (
paymentManagerArn,
paymentConnectorId,
paymentInstrumentType,
paymentInstrumentDetails,
clientToken,
region,
`X-Amzn-Bedrock-AgentCore-Payments-User-Id`,
`X-Amzn-Bedrock-AgentCore-Payments-Agent-Name`
)
SELECT 
'{{ paymentManagerArn }}' /* required */,
'{{ paymentConnectorId }}' /* required */,
'{{ paymentInstrumentType }}' /* required */,
'{{ paymentInstrumentDetails }}' /* required */,
'{{ clientToken }}',
'{{ region }}',
'{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}',
'{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}'
RETURNING
payment_instrument
;

# Description fields are for documentation purposes
- name: payment_instruments
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the payment_instruments resource.
  - name: paymentManagerArn
    value: "{{ paymentManagerArn }}"
  - name: paymentConnectorId
    value: "{{ paymentConnectorId }}"
  - name: paymentInstrumentType
    value: "{{ paymentInstrumentType }}"
    description: |
      The type of payment instrument.
    valid_values: ['EMBEDDED_CRYPTO_WALLET']
  - name: paymentInstrumentDetails
    description: |
      Details specific to the instrument type.
    value:
      embeddedCryptoWallet:
        network: "{{ network }}"
        linkedAccounts:
          - email:
              emailAddress: "{{ emailAddress }}"
            sms:
              phoneNumber: "{{ phoneNumber }}"
            developerJwt:
              kid: "{{ kid }}"
              sub: "{{ sub }}"
            oAuth2:
              google:
                sub: "{{ sub }}"
                emailAddress: "{{ emailAddress }}"
                name: "{{ name }}"
                username: "{{ username }}"
              apple:
                sub: "{{ sub }}"
                emailAddress: "{{ emailAddress }}"
                name: "{{ name }}"
                username: "{{ username }}"
              x:
                sub: "{{ sub }}"
                emailAddress: "{{ emailAddress }}"
                name: "{{ name }}"
                username: "{{ username }}"
              telegram:
                sub: "{{ sub }}"
                emailAddress: "{{ emailAddress }}"
                name: "{{ name }}"
                username: "{{ username }}"
              github:
                sub: "{{ sub }}"
                emailAddress: "{{ emailAddress }}"
                name: "{{ name }}"
                username: "{{ username }}"
        walletAddress: "{{ walletAddress }}"
        redirectUrl: "{{ redirectUrl }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: X-Amzn-Bedrock-AgentCore-Payments-User-Id
    value: "{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}"
    description: The user ID associated with this payment instrument.
    description: The user ID associated with this payment instrument.
  - name: X-Amzn-Bedrock-AgentCore-Payments-Agent-Name
    value: "{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}"
    description: The agent name associated with this request, used for observability.
    description: The agent name associated with this request, used for observability.

`DELETE` examples

delete_payment_instrument

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

DELETE FROM aws.bedrock_agentcore.payment_instruments
WHERE region = '{{ region }}' --required
AND `X-Amzn-Bedrock-AgentCore-Payments-User-Id` = '{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}'
;

Lifecycle Methods

process_payment

Processes a payment using a payment instrument within a payment session.

EXEC aws.bedrock_agentcore.payment_instruments.process_payment 
@region='{{ region }}' --required, 
@X-Amzn-Bedrock-AgentCore-Payments-User-Id='{{ X-Amzn-Bedrock-AgentCore-Payments-User-Id }}', 
@X-Amzn-Bedrock-AgentCore-Payments-Agent-Name='{{ X-Amzn-Bedrock-AgentCore-Payments-Agent-Name }}' 
@@json=
'{
"paymentManagerArn": "{{ paymentManagerArn }}", 
"paymentSessionId": "{{ paymentSessionId }}", 
"paymentInstrumentId": "{{ paymentInstrumentId }}", 
"paymentType": "{{ paymentType }}", 
"paymentInput": "{{ paymentInput }}", 
"clientToken": "{{ clientToken }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

DELETE examples​

Lifecycle Methods​