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

ListPaymentInstruments

List payment instruments for a manager.

Request Syntax


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

{
   "maxResults": number,
   "nextToken": "string",
   "paymentConnectorId": "string",
   "paymentManagerArn": "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 the payment instruments.

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

Request Body

The request accepts the following data in JSON format.

maxResults

Maximum number of results to return in a single response.

Type: Integer

Required: No

nextToken

Token for pagination to retrieve the next set of results.

Type: String

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

Pattern: \S*

Required: No

paymentConnectorId

The ID of the payment connector to filter by.

Type: String

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

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

Required: No

paymentManagerArn

The ARN of the payment manager that owns the payment instruments.

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

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "paymentInstruments": [ 
      { 
         "createdAt": "string",
         "paymentConnectorId": "string",
         "paymentInstrumentId": "string",
         "paymentInstrumentType": "string",
         "paymentManagerArn": "string",
         "status": "string",
         "updatedAt": "string",
         "userId": "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.

nextToken

Token for pagination to retrieve the next set of results.

Type: String

paymentInstruments

List of payment instrument summaries matching the request criteria.

Type: Array of PaymentInstrumentSummary objects

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

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