PaymentInstrument

Represents a payment instrument.

createdAt

The timestamp when this payment instrument was created.

Type: Timestamp

Required: Yes

paymentConnectorId

The ID of the payment connector associated with this instrument.

Type: String

Length Constraints: Minimum length of 12. Maximum length of 211.

Pattern: ([0-9a-z][-]?){1,100}-[0-9a-z]{10}

Required: Yes

paymentInstrumentDetails

The details specific to the payment instrument type.

Type: PaymentInstrumentDetails object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

paymentInstrumentId

The unique identifier for this payment instrument.

Type: String

Length Constraints: Fixed length of 34.

Pattern: payment-instrument-[0-9a-zA-Z-]{15}

Required: Yes

paymentInstrumentType

The type of payment instrument (e.g., EMBEDDED_CRYPTO_WALLET).

Type: String

Valid Values: EMBEDDED_CRYPTO_WALLET

Required: Yes

paymentManagerArn

The ARN of the payment manager that owns this payment instrument.

Type: String

Length Constraints: Minimum length of 66. Maximum length of 2048.

Pattern: 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}

Required: Yes

status

The current status of this payment instrument.

Type: String

Valid Values: INITIATED | ACTIVE | FAILED | DELETED | BLOCKED

Required: Yes

updatedAt

The timestamp when this payment instrument was last updated.

Type: Timestamp

Required: Yes

userId

The user ID associated with this payment instrument.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 120.

Required: Yes

PaymentInstrument

Contents

See Also