Transaction Channels Configuration

A transaction channel is a form of payment such as cash, POS device, receipt, check, bank and so on.

Mambu ships with one predefined transaction channel — cash — but you can add other transaction channels as needed for your organization. For more information, see Transaction Channels.

With Configuration as Code (CasC), you may batch configure your transaction channels configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.

API Operations

CasC for transaction channels supports two operations.

Requests

For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.

The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.

GET configuration

curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/transactionchannels.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

PUT configuration

curl -X PUT 'https://TENANT_NAME.mambu.com/api/configuration/transactionchannels.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @transactionchannels.yaml

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

“@transactionchannels.yaml” represents the absolute path of the file on your device.

(Use “--data-raw” if you want to specify the YAML body inline).

Configuration body example

---
defaultTransactionChannel:
  id: "cash"
  name: "Cash"
  state: "ACTIVE"
  loansConstraints:
    usage: "UNCONSTRAINED_USAGE"
    constraints: []
  savingsConstraints:
    usage: "UNCONSTRAINED_USAGE"
    constraints: []
  usageRights:
    roles: []
    allUsers: true
transactionChannels:
- id: "63547"
  name: "Visa Card"
  state: "ACTIVE"
  loansConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "PRODUCT"
      filterElement: "EMPTY"
      values: []
    matchFilter: "ALL"
  savingsConstraints:
    usage: "UNCONSTRAINED_USAGE"
    constraints: []
  glAccountCode: "66734"
  usageRights:
    roles:
    - "35436"
    allUsers: false
- id: "837489"
  name: "Master card "
  state: "ACTIVE"
  loansConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "PRODUCT"
      filterElement: "EMPTY"
      values: []
    matchFilter: "ALL"
  savingsConstraints:
    usage: "UNCONSTRAINED_USAGE"
    constraints: []
  glAccountCode: "68982"
  usageRights:
    roles:
    - "43643"
    allUsers: false
- id: "83203"
  name: "BACS"
  state: "ACTIVE"
  loansConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "AMOUNT"
      filterElement: "LESS_THAN"
      values:
      - "9999.99"
    matchFilter: "ALL"
  savingsConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "AMOUNT"
      filterElement: "LESS_THAN"
      values:
      - "9999.99"
    matchFilter: "ALL"
  glAccountCode: "54323"
  usageRights:
    roles:
    - "1064356630"
    allUsers: false
- id: "82352"
  name: "CHAPS"
  state: "ACTIVE"
  loansConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "AMOUNT"
      filterElement: "MORE_THAN"
      values:
      - "10000.00"
    matchFilter: "ALL"
  savingsConstraints:
    usage: "LIMITED_USAGE"
    constraints:
    - criteria: "AMOUNT"
      filterElement: "MORE_THAN"
      values:
      - "10000.00"
    matchFilter: "ALL"
  glAccountCode: "63213"
  usageRights:
    roles:
    - "1108047100"
    allUsers: false

Attributes

Transaction channel configuration attributes

Transaction channel attributes

Loan and savings constraint attributes

Replies

Validations

With all use cases, a validation of the uploaded file will be done, ensuring the following:

• Syntax is correct as per YAML standards and the template for holidays.
• Minimum requirements indicates the line with the syntax error.
• Content is correct.

Configuration settings may be specified in any order.

Transaction channel attribute validations

Access rights validations

Constraint attribute validations

Warnings

In case a transaction channel cannot be deleted, it will be deactivated and the following warning will be returned: TransactionChannel [tr2] could not be deleted: The transaction channel cannot be deleted since it is used in a transaction.