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

CreatePaymentSession

Create a new payment session.

Request Syntax


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

{
   "clientToken": "string",
   "expiryTimeInMinutes": number,
   "limits": { 
      "maxSpendAmount": { 
         "currency": "string",
         "value": "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 this payment session.

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

Request Body

The request accepts the following data in JSON format.

clientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,256}

Required: No

expiryTimeInMinutes

The session expiry time in minutes. Must be between 15 and 480 minutes.

Type: Integer

Valid Range: Minimum value of 15. Maximum value of 480.

Required: Yes

limits

The spending limits for this payment session.

Type: SessionLimits object

Required: No

paymentManagerArn

The ARN of the payment manager that owns this session.

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 201
Content-type: application/json

{
   "paymentSession": { 
      "availableLimits": { 
         "availableSpendAmount": { 
            "currency": "string",
            "value": "string"
         },
         "updatedAt": "string"
      },
      "createdAt": "string",
      "expiryTimeInMinutes": number,
      "limits": { 
         "maxSpendAmount": { 
            "currency": "string",
            "value": "string"
         }
      },
      "paymentManagerArn": "string",
      "paymentSessionId": "string",
      "updatedAt": "string",
      "userId": "string"
   }
}

Response Elements

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

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

paymentSession

The created payment session.

Type: PaymentSession 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

ConflictException

The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

HTTP Status Code: 402

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