Developer Center

Transaction Channels API

Last Updated: Feb 20, 2017 04:31PM CET

URL

/api/transactionchannels

Description

Allows the retrieval of a list of all transaction channels in the organisation.

Methods

GET TransactionChannels

Get a list of channels in JSON format.

Usage examples

// Get all transaction channels along with associated custom fields definition.
GET /api/transactionchannels

Response

A 200 OK response will be issued with a list of templates.
[
   {
      "encodedKey":"8a0b8a2b4b9f463f014ba2627d910761",
      "channelFields":[

      ],
      "id":"multicred",
      "name":"Multicredit",
      "createdByUserKey":"8a3e492e4b30343b014b316db58b0121",
      "creationDate":"2015-02-19T15:08:59+0000",
      "index":2147483647,
      "activated":true,
      "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
      "loanConstraints": 
         {
            "encodedKey": "4028809258fe98710158fe9871550001",
            "filterConstraints": []
         },
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "savingsConstraints": 
         {
            "encodedKey": "8a80870a5908937f01590897b7ae000e",
            "filterConstraints": []
         }
   },
   {
      "encodedKey":"8a5103ac47aaf9e60147abc3130b011d",
      "channelFields":[
         "IDENTIFIER"
      ],
      "id":"BANK",
      "name":"BANK",
      "createdByUserKey":"8ae02be94371dfe3014371e7a7750020",
      "creationDate":"2014-08-06T14:39:54+0000",
      "index":2147483647,
      "activated":true,
      "loanConstraintsUsage": "LIMITED_USAGE",
      "loanConstraints": {
            "encodedKey": "4028809258fe98710158fe9871550001",
            "filterConstraints": [
            	{
                     "encodedKey": "4028809258fe98710158fe9871550002",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "TRANSACTION",
                     "dataType": "ENUM",
                     "dataFieldValue": "EVENT",
                     "filterElement": "IN",
                     "value": "DISBURSMENT",
                     "linkingOperator": "AND",
                     "groupNumber": 10
                  },
                  {
                     "encodedKey": "4028809258fe98710158fe9871550003",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "LOANS",
                     "dataType": "KEY",
                     "dataFieldValue": "PRODUCT_KEY",
                     "filterElement": "IN",
                     "value": "4028809258fc15dd0158fc17a65c034c",
                     "linkingOperator": "AND",
                     "groupNumber": 10
                  },
                  {
                     "encodedKey": "4028809258fe98710158fe9871550004",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "TRANSACTION",
                     "dataType": "MONEY",
                     "dataFieldValue": "AMOUNT",
                     "filterElement": "MORE_THAN",
                     "value": "100.00",
                     "secondValue": "",
                     "linkingOperator": "AND",
                     "groupNumber": 10
            	}
      	    ]
      	},
      	"savingsConstraintsUsage": "LIMITED_USAGE",
      	"savingsConstraints": {
            "encodedKey": "8a80870a5908937f01590897b7ae000e",
            "filterConstraints": [
            	{
                     "encodedKey": "4028809258fe98710158fe9871550002",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "TRANSACTION",
                     "dataType": "ENUM",
                     "dataFieldValue": "EVENT",
                     "filterElement": "IN",
                     "value": "DEPOSIT,WITHDRAWAL",
                     "linkingOperator": "AND",
                     "groupNumber": 10
                  },
                  {
                     "encodedKey": "4028809258fe98710158fe9871550003",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "SAVINGS",
                     "dataType": "KEY",
                     "dataFieldValue": "PRODUCT_KEY",
                     "filterElement": "IN",
                     "value": "8a80865d59078eaa015907c891420132",
                     "linkingOperator": "AND",
                     "groupNumber": 10
                  },
                  {
                     "encodedKey": "4028809258fe98710158fe9871550004",
                     "dataFieldType": "NATIVE",
                     "dataItemType": "TRANSACTION",
                     "dataType": "MONEY",
                     "dataFieldValue": "AMOUNT",
                     "filterElement": "MORE_THAN",
                     "value": "100.00",
                     "secondValue": "",
                     "linkingOperator": "AND",
                     "groupNumber": 10
            	}
      	    ]
      	},
      "customFields":[
         {
            "encodedKey":"8a80802a53d214ba0153e0eca1550ad7",
            "id":"IDENTIFIER_TRANSACTION_CHANNEL_I",
            "creationDate":"2016-04-15T06:59:18+0000",
            "lastModifiedDate":"2016-04-15T06:59:18+0000",
            "name":"Identifier",
            "type":"TRANSACTION_CHANNEL_INFO",
            "dataType":"STRING",
            "valueLength":"SHORT",
            "isDefault":false,
            "isRequired":false,
            "description":"",
            "customFieldSet":{
               "encodedKey":"8a80802a53d214ba0153e0eca13c0ad6",
               "indexInList":0,
               "usage":"SINGLE"
            },
            "indexInList":0,
            "customFieldProductSettings":[
               {
                  "encodedKey":"8a80802a53d214ba0153e0eca1c20aec",
                  "linkType":"CHANNEL",
                  "productKey":"8a124c5c4619ffe901461a0d991c00e2",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a8080b15416793e015418b7798f0119",
                  "linkType":"CHANNEL",
                  "productKey":"8a8080b15416793e015418b5ddaf0114",
                  "isDefault":true,
                  "isRequired":false
               }
            ],
            "state":"NORMAL",
            "customFieldSelectionOptions":[

            ],
            "viewRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca1550ad8",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "editRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca1550ad9",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "unique":true,
            "values":[

            ],
            "amounts":{

            }
         },
         {
            "encodedKey":"8a8080b1540761b301540a7bea330368",
            "id":"5_Transactions",
            "creationDate":"2016-04-12T12:39:34+0000",
            "lastModifiedDate":"2016-04-12T12:39:34+0000",
            "name":"5",
            "type":"TRANSACTION_CHANNEL_INFO",
            "dataType":"SELECTION",
            "valueLength":"SHORT",
            "isDefault":false,
            "isRequired":false,
            "description":"",
            "customFieldSet":{
               "encodedKey":"8a80802a53d214ba0153e0eca13c0ad6",
               "indexInList":0,
               "usage":"SINGLE"
            },
            "indexInList":7,
            "customFieldProductSettings":[
               {
                  "encodedKey":"8a8080b1540761b301540a7bea41036b",
                  "linkType":"CHANNEL",
                  "productKey":"8a124c5c4619ffe901461a0d991c00e2",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a8080b1540761b301540a7bea46036c",
                  "linkType":"CHANNEL",
                  "productKey":"8a0b8a2b4b9f463f014ba2627d910761",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a8080b1540761b301540a7bea4a036d",
                  "linkType":"CHANNEL",
                  "productKey":"8a3ed7584b9c66e1014b9d81f8f2032a",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a8080b1540761b301540a7bea4d036e",
                  "linkType":"CHANNEL",
                  "productKey":"8a5103ac47aaf9e60147abc3130b011d",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a8080b1540761b301540a7bea50036f",
                  "linkType":"CHANNEL",
                  "productKey":"8ac9053748eaa70b0148efb4df021a88",
                  "isDefault":true,
                  "isRequired":false
               }
            ],
            "state":"NORMAL",
            "customFieldSelectionOptions":[

            ],
            "viewRights":{
               "encodedKey":"8a8080b1540761b301540a7bea330369",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "editRights":{
               "encodedKey":"8a8080b1540761b301540a7bea34036a",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "unique":false,
            "values":[

            ],
            "amounts":{

            }
         }
      ]
   },
   {
      "encodedKey":"8a5103ac47aaf9e60147abc3130b011d",
      "channelFields":[
         "BANK_NUMBER",
         "ACCOUNT_NUMBER"
      ],
      "id":"BANK",
      "name":"BANK",
      "createdByUserKey":"8ae02be94371dfe3014371e7a7750020",
      "creationDate":"2014-08-06T14:39:54+0000",
      "index":2147483647,
      "activated":true,
      "loanConstraintsUsage": "UNCONSTRAINED_USAGE",
      "loanConstraints": 
         {
            "encodedKey": "4028809258fe98710158fe9871550001",
            "filterConstraints": []
         },
      "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
      "savingsConstraints": 
         {
            "encodedKey": "8a80870a5908937f01590897b7ae000e",
            "filterConstraints": []
         }
      "usageRights":{
         "encodedKey":"8a17ed7e4f1cf5cd014f1d06ec540084",
         "isAccessibleByAllUsers":true,
         "roles":[

         ]
      },
      "transactionChannelAccountingRule":{
         "encodedKey":"8a099bf64db1cf54014db36e561e04f1",
         "financialResource":"FUND_SOURCE",
         "account":{
            "encodedKey":"8a099bf64db1cf54014db36d93a204ed",
            "creationDate":"2015-06-02T08:40:12+0000",
            "lastModifiedDate":"2015-06-02T08:40:12+0000",
            "glCode":"11200",
            "type":"ASSET",
            "usage":"DETAIL",
            "name":"Bank Account",
            "activated":true,
            "description":"",
            "allowManualJournalEntries":true,
            "stripTrailingZeros":true
         },
         "index":0,
         "transactionChannelKey":"8a5103ac47aaf9e60147abc3130b011d"
      },
      "customFields":[
         {
            "encodedKey":"8a80802a53d214ba0153e0eca1630ada",
            "id":"BANK_NUMBER_TRANSACTION_CHANNEL_",
            "creationDate":"2016-04-15T06:58:11+0000",
            "lastModifiedDate":"2016-04-15T06:58:43+0000",
            "name":"Bank #",
            "type":"TRANSACTION_CHANNEL_INFO",
            "dataType":"STRING",
            "valueLength":"SHORT",
            "isDefault":false,
            "isRequired":false,
            "description":"",
            "customFieldSet":{
               "encodedKey":"8a80802a53d214ba0153e0eca13c0ad6",
               "indexInList":0,
               "usage":"SINGLE"
            },
            "indexInList":1,
            "customFieldProductSettings":[
               {
                  "encodedKey":"8a80802a53d214ba0153e0eca1d00aed",
                  "linkType":"CHANNEL",
                  "productKey":"8a5103ac47aaf9e60147abc3130b011d",
                  "isDefault":true,
                  "isRequired":true
               },
               {
                  "encodedKey":"8a8080b15416793e015418b6731f0116",
                  "linkType":"CHANNEL",
                  "productKey":"8a8080b15416793e015418b5ddaf0114",
                  "isDefault":true,
                  "isRequired":true
               },
               {
                  "encodedKey":"8a80802a53d214ba0153e0eca1d30aee",
                  "linkType":"CHANNEL",
                  "productKey":"8ac9053748eaa70b0148efb4df021a88",
                  "isDefault":true,
                  "isRequired":false
               }
            ],
            "state":"NORMAL",
            "customFieldSelectionOptions":[

            ],
            "viewRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca1640adb",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "editRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca1640adc",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "unique":false,
            "values":[

            ],
            "amounts":{

            }
         },
         {
            "encodedKey":"8a80802a53d214ba0153e0eca18a0ae3",
            "id":"ACCOUNT_NUMBER_TRANSACTION_CHANN",
            "name":"Account #",
            "type":"TRANSACTION_CHANNEL_INFO",
            "dataType":"STRING",
            "valueLength":"SHORT",
            "isDefault":false,
            "isRequired":false,
            "customFieldSet":{
               "encodedKey":"8a80802a53d214ba0153e0eca13c0ad6",
               "indexInList":0,
               "usage":"SINGLE"
            },
            "indexInList":4,
            "customFieldProductSettings":[
               {
                  "encodedKey":"8a80802a53d214ba0153e0eca1fe0af1",
                  "linkType":"CHANNEL",
                  "productKey":"8a5103ac47aaf9e60147abc3130b011d",
                  "isDefault":true,
                  "isRequired":false
               },
               {
                  "encodedKey":"8a80802a53d214ba0153e0eca2010af2",
                  "linkType":"CHANNEL",
                  "productKey":"8ac9053748eaa70b0148efb4df021a88",
                  "isDefault":true,
                  "isRequired":false
               }
            ],
            "state":"NORMAL",
            "customFieldSelectionOptions":[

            ],
            "viewRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca18a0ae4",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "editRights":{
               "encodedKey":"8a80802a53d214ba0153e0eca18a0ae5",
               "isAccessibleByAllUsers":false,
               "roles":[

               ]
            },
            "unique":false,
            "values":[

            ],
            "amounts":{

            }
         }
      ]
   }
]
support@mambu.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete