Skip to content

Restrictions

Restrictions identify transaction types that are permitted, account types that can be used with these transaction types, and limits on minimum and maximum amounts or currency types.

Restriction Object

A restriction object may include the following properties:

Property Type Required? (default) Description
transactionTypeId string or number yes code for transaction type
transactionType string yes description of transaction type
allowed boolean yes true if this transaction type is allowed
maxAmount number no (unlimited) maximum amount for the transaction, in the specified currency
maxAmountCurrency string yes, if maxAmonut given 3-letter currency code
minAmount number no (0) minimum amount for the transaction, in the specified currency
minAmountCurrency string yes, if minAmonut given 3-letter currency code
allowedTransactionCurrencies list of strings yes list of 3-letter currency codes
sourceAccountTypes list of strings or numbers yes if transaction originates from a user account types of user accounts permitted
destinationAccountTypes list of strings or numbers yes if transaction is a transfar to a user account types of user accounts permitted

List Restrictions

GET /restrictions/

List all the restrictions related to transactions by the current user.

Response body:

  [ // array of Restriction Objects
  ]