getPaymentInstrument method

Future<GetPaymentInstrumentResponse> getPaymentInstrument({ required String paymentInstrumentId, required String paymentManagerArn, String? agentName, String? paymentConnectorId, String? userId, })

Get a payment instrument by ID.

May throw AccessDeniedException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter paymentInstrumentId : The ID of the payment instrument to retrieve.

Parameter paymentManagerArn : The ARN of the payment manager that owns this payment instrument.

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

Parameter paymentConnectorId : The ID of the payment connector.

Parameter userId : The user ID associated with this payment instrument.

Implementation

Future<GetPaymentInstrumentResponse> getPaymentInstrument({
  required String paymentInstrumentId,
  required String paymentManagerArn,
  String? agentName,
  String? paymentConnectorId,
  String? userId,
}) async {
  final headers = <String, String>{
    if (agentName != null)
      'X-Amzn-Bedrock-AgentCore-Payments-Agent-Name': agentName.toString(),
    if (userId != null)
      'X-Amzn-Bedrock-AgentCore-Payments-User-Id': userId.toString(),
  };
  final $payload = <String, dynamic>{
    'paymentInstrumentId': paymentInstrumentId,
    'paymentManagerArn': paymentManagerArn,
    if (paymentConnectorId != null) 'paymentConnectorId': paymentConnectorId,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/payments/getPaymentInstrument',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  return GetPaymentInstrumentResponse.fromJson(response);
}