getCheckoutSettings method

Future<CheckoutSettings> getCheckoutSettings(
  1. String name, {
  2. String? $fields,
})

Gets CheckoutSettings for the given merchant.

This includes information about review state, enrollment state and URL settings.

Request parameters:

name - Required. The name/identifier of the merchant account. Format: accounts/{account}/programs/{program}/checkoutSettings Value must have pattern ^accounts/\[^/\]+/programs/\[^/\]+/checkoutSettings$.

$fields - Selector specifying which fields to include in a partial response.

Completes with a CheckoutSettings.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<CheckoutSettings> getCheckoutSettings(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'accounts/v1/' + core.Uri.encodeFull('$name');

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return CheckoutSettings.fromJson(
    response_ as core.Map<core.String, core.dynamic>,
  );
}