Rules

Visit Rules for background details.

The rules API client allows rules specific to currency and country to be retrieved, this is includes domestic and non-domestic rules as well allowing the route type to be specified (e.g. Bank Account, Cheque etc) and optionally an account ID.

Below are some code samples that show how this client can be used.

Configure a new rules API client

var config = new Configuration("{api-token}", Environment.Staging);
IRuleApiClient rulesClient = new RuleApiClient(config);

Retrieve rules

// retrieve domestic rules
IEnumerable<RuleField> gbGbpRules = 
  await rulesClient.GetRulesAsync(Country.GB, Currency.GBP);

// retrieve domestic rules with a specified RouteType (default is BankAccount)
IEnumerable<RuleField> usUsdRules = 
  await rulesClient.GetRulesAsync(Country.US, Currency.USD, RouteType.Cheque);

// retrieve domestic rules with a specified RouteType for a specific account
IEnumerable<RuleField> usUsdRules = 
  await rulesClient.GetRulesAsync(Country.US, Currency.USD, RouteType.Cheque, accountId: 700);

// retrieve non-domestic rules
IEnumerable<RuleField> gbUsdRules = 
  await rulesClient.GetRulesAsync(Country.GB, Currency.USD);