Skip to main content

Account and Transactions

Permissions

Permissions codes will be used to limit the data that is returned in response to a resource request.

When a permission is granted for a "Detail" permission code (e.g., ReadAccountsDetail), it implies that access is also granted to the corresponding "Basic" permission code (e.g., ReadAccountsBasic)

The following combinations of permissions are disallowed:

  • Account requests with an empty Permissions array
  • Account requests with a Permissions array that contains ReadTransactionsBasic but does not contain at least one of ReadTransactionsCredits and ReadTransactionsDebits.
  • Account requests with a Permissions array that contains ReadTransactionsDetail but does not contain at least one of ReadTransactionsCredits and ReadTransactionsDebits.
  • Account requests with a Permissions array that contains ReadTransactionsCredits but does not contain at least one of ReadTransactionsBasic and ReadTransactionsDetails.
  • Account requests with a Permissions array that contains ReadTransactionsDebits but does not contain at least one of ReadTransactionsBasic and ReadTransactionsDetails.
PermissionDescription
ReadAccountsBasicRead basic account information (i.e., account number, balance, available balance, currency)
ReadAccountsDetailRead extended account information (i.e., account name, address, phone number)
ReadBalancesAbility to read all balance information
ReadTransactionsBasicRead basic transaction information (i.e., transaction date, amount, currency)
ReadTransactionsCreditsRead credit transactions
ReadTransactionsDebitsRead debit transactions
ReadTransactionsDetailRead extended transaction information (i.e., reference, merchant category code)