Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetPaymentInstrumentBalance

Get the balance of a payment instrument.

Request Syntax


POST /payments/getPaymentInstrumentBalance HTTP/1.1
X-Amzn-Bedrock-AgentCore-Payments-User-Id: userId
X-Amzn-Bedrock-AgentCore-Payments-Agent-Name: agentName
Content-type: application/json

{
   "chain": "string",
   "paymentConnectorId": "string",
   "paymentInstrumentId": "string",
   "paymentManagerArn": "string",
   "token": "string"
}

URI Request Parameters

The request uses the following URI parameters.

agentName

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

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

userId

The user ID associated with this payment instrument.

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

Request Body

The request accepts the following data in JSON format.

chain

The specific blockchain chain to query balance on. Required because balances are chain-specific.

Type: String

Valid Values: BASE | BASE_SEPOLIA | ETHEREUM | SOLANA | SOLANA_DEVNET

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

paymentInstrumentId

The ID of the payment instrument to query balance for.

Type: String

Length Constraints: Fixed length of 34.

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

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

token

The token to query balance for. Only tokens supported for X402 payments are returned.

Type: String

Valid Values: USDC

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "paymentInstrumentId": "string",
   "tokenBalance": { 
      "amount": "string",
      "chain": "string",
      "decimals": number,
      "network": "string",
      "token": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

paymentInstrumentId

The ID of the payment instrument.

Type: String

Length Constraints: Fixed length of 34.

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

tokenBalance

The balance of the supported token on the requested chain.

Type: TokenBalance object

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

HTTP Status Code: 403

InternalServerException

The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

HTTP Status Code: 500

ResourceNotFoundException

The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

HTTP Status Code: 404

ThrottlingException

The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

HTTP Status Code: 429

ValidationException

The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

HTTP Status Code: 400