Post paymentsgetpaymentinstrumentbalance — bedrock-agentcore

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465766489.0 KB

Get the balance of a payment instrument.

post/payments/getPaymentInstrumentBalance

Headers

X-Amzn-Bedrock-AgentCore-Payments-User-Idstring

The user ID associated with this payment instrument.

X-Amzn-Bedrock-AgentCore-Payments-Agent-Namestring

The agent name associated with the payment request.

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

Request body

paymentManagerArnstring required

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

paymentConnectorIdstring required

The ID of the payment connector associated with this instrument.

paymentInstrumentIdstring required

The ID of the payment instrument to query balance for.

chain'BASE' | 'BASE_SEPOLIA' | 'ETHEREUM' | 'SOLANA' | 'SOLANA_DEVNET' required

Supported blockchain chain identifiers for balance queries. Each value maps to a specific chain supported by the underlying providers (Privy, Coinbase).

token'USDC' required

Supported tokens for instrument balance queries. Only tokens supported for X402 payments are returned.

Response

Success

paymentInstrumentIdstring required

The ID of the payment instrument.