Developer Center

Savings Transactions API

Last Updated: Oct 03, 2018 02:52PM CEST

URL

/api/savings/{ID}/transactions
/api/savings/transactions/search
/api/savings/{ID}/transactions/templates/{templateId}

Description

Allows you to retrieve and post transactions for a savings account. Various transactions can be posted including:
  • Approving a savings account
  • Undo approving a savings accunt
  • Making a Deposit
  • Making a Withdrawal
  • Making a Transfer
  • Applying a Fee
  • Closing a savings account

Methods

GET Transactions

Allows for retrieving savings transactions for a specific account.Transactions are returned in order sorted by most recent to oldest

Usage examples

// Get the top 10 transactions for account KHGJ593
GET /api/savings/KHGJ593/transactions?offset=0&limit=10

// get a specific document for a savings transaction
GET /api/savings/ABC9999/transactions/templates/40288a134744a69a0147488ab9b10067

Samples responses

[
    {
        "encodedKey": "8a858f145f489bdb015f49e409e81e11",
        "transactionId": 86,
        "parentAccountKey": "8a858f145f489bdb015f49ded8ea1caf",
        "type": "WITHDRAWAL",
        "comment": "",
        "creationDate": "2017-10-23T15:40:02+0000",
        "entryDate": "2017-10-23T15:40:02+0000",
        "amount": "-2",
        "interestAmount": "0",
        "feesAmount": "0",
        "overdraftAmount": "0",
        "fundsAmount": "2",
        "feesPaid": "0",
        "interestPaid": "0",
        "balance": "21",
        "details": {
            "encodedKey": "8a858f145f489bdb015f49e409e81e12",
            "transactionChannelKey": "8a85895b50eb44220150eb4452a0000a",
            "internalTransfer": false,
            "transactionChannel": {
                "encodedKey": "8a85895b50eb44220150eb4452a0000a",
                "id": "cash",
                "name": "Cash",
                "creationDate": "2015-11-09T08:02:14+0000",
                "index": 0,
                "activated": true,
                "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
                "savingsConstraints": {
                    "encodedKey": "8a858f9c5ac133f9015ac1345f780061",
                    "filterConstraints": []
                },
                "usageRights": {
                    "encodedKey": "8a85895b50eb44220150eb4452a1000b",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                }
            }
        },
        "userKey": "8a85895b50eb44220150eb442cdb0004",
        "branchKey": "8a858f23573921ad01574d656b6538ae",
        "centreKey": "8a858f23573921ad01574d67c02e3952",
        "savingsPredefinedFeeAmounts": [],
        "productTypeKey": "8a858f545908094b015921ef648252c7",
        "currencyCode": "USD",
        "customInformation": [
            {
                "encodedKey": "8a858f145f489bdb015f49e409e81e13",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a20fd1353",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a20fd1353",
                    "id": "IDENTIFIER_TRANSACTION_CHANNEL_I",
                    "creationDate": "2016-09-22T14:07:31+0000",
                    "lastModifiedDate": "2017-02-22T15:34:53+0000",
                    "name": "Identifier",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "An unique user-defined identifier for each transaction. This field is optional, but if specified, it must be unique across all loan and deposit transactions",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 0,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a20fd1354",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21001358",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "123443",
                "indexInList": -1,
                "customFieldID": "IDENTIFIER_TRANSACTION_CHANNEL_I",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e409e81e14",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a210e135c",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a210e135c",
                    "id": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                    "creationDate": "2017-05-31T08:19:22+0000",
                    "lastModifiedDate": "2017-05-31T08:19:22+0000",
                    "name": "Bank #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 1,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135d",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135f",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "BO",
                "indexInList": -1,
                "customFieldID": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e409e81e15",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a21131362",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21131362",
                    "id": "RECEPIT_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:33+0000",
                    "lastModifiedDate": "2017-05-31T08:19:33+0000",
                    "name": "Receipt #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 2,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21131363",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21131364",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "123453Rec",
                "indexInList": -1,
                "customFieldID": "RECEPIT_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e16",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a21171368",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21171368",
                    "id": "CHECK_NUMBER_TRANSACTION_CHANNEL",
                    "creationDate": "2017-05-31T08:19:40+0000",
                    "lastModifiedDate": "2017-05-31T08:19:40+0000",
                    "name": "Check #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 3,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21171369",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a2117136a",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "5543FF",
                "indexInList": -1,
                "customFieldID": "CHECK_NUMBER_TRANSACTION_CHANNEL",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e17",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a211c136c",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a211c136c",
                    "id": "ACCOUNT_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:46+0000",
                    "lastModifiedDate": "2017-05-31T08:19:46+0000",
                    "name": "Account #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 4,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a211d136d",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a211d136e",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "AA7843",
                "indexInList": -1,
                "customFieldID": "ACCOUNT_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e18",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a21241373",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21241373",
                    "id": "ACCOUNT_NAME_TRANSACTION_CHANNEL",
                    "creationDate": "2017-05-31T08:19:51+0000",
                    "lastModifiedDate": "2017-05-31T08:19:51+0000",
                    "name": "Account Name",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 5,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21241374",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21241375",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "AExample",
                "indexInList": -1,
                "customFieldID": "ACCOUNT_NAME_TRANSACTION_CHANNEL",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e19",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a85898b548f54af01548f6a212a137a",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a212a137a",
                    "id": "ROUTING_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:57+0000",
                    "lastModifiedDate": "2017-05-31T08:19:57+0000",
                    "name": "Routing #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 6,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a212a137b",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a212a137c",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "FF434FF",
                "indexInList": -1,
                "customFieldID": "ROUTING_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e1a",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a858f145f489bdb015f49df74191ce3",
                "customField": {
                    "encodedKey": "8a858f145f489bdb015f49df74191ce3",
                    "id": "TTFC1",
                    "creationDate": "2017-10-23T15:36:23+0000",
                    "lastModifiedDate": "2017-10-23T15:36:59+0000",
                    "name": "TestTransactionCustomfield1",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce2",
                        "id": "TETF",
                        "name": "Test Extra Transaction Fields",
                        "notes": "",
                        "createdDate": "2017-10-23T15:36:10+0000",
                        "indexInList": 1,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 7,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce4",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b02c1d3a",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "extraCustomField",
                "indexInList": -1,
                "customFieldID": "TTFC1",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e40a221e1b",
                "parentKey": "8a858f145f489bdb015f49e409e81e11",
                "customFieldKey": "8a858f145f489bdb015f49e0b0331d41",
                "customField": {
                    "encodedKey": "8a858f145f489bdb015f49e0b0331d41",
                    "id": "TTFC2",
                    "creationDate": "2017-10-23T15:36:39+0000",
                    "lastModifiedDate": "2017-10-23T15:36:39+0000",
                    "name": "TestTransactionCustomfield2",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "NUMBER",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce2",
                        "id": "TETF",
                        "name": "Test Extra Transaction Fields",
                        "notes": "",
                        "createdDate": "2017-10-23T15:36:10+0000",
                        "indexInList": 1,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 8,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b0331d42",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b0331d43",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "43",
                "indexInList": -1,
                "customFieldID": "TTFC2",
                "customFieldSetGroupIndex": -1
            }
        ]
    },
    {
        "encodedKey": "8a858f145f489bdb015f49df74191ce0",
        "transactionId": 85,
        "parentAccountKey": "8a858f145f489bdb015f49ded8ea1caf",
        "type": "DEPOSIT",
        "comment": "",
        "creationDate": "2017-10-23T15:35:02+0000",
        "entryDate": "2017-10-23T15:35:02+0000",
        "amount": "23",
        "interestAmount": "0",
        "feesAmount": "0",
        "overdraftAmount": "0",
        "fundsAmount": "23",
        "feesPaid": "0",
        "interestPaid": "0",
        "balance": "23",
        "details": {
            "encodedKey": "8a858f145f489bdb015f49df74191ce1",
            "transactionChannelKey": "8a85895b50eb44220150eb4452a0000a",
            "internalTransfer": false,
            "transactionChannel": {
                "encodedKey": "8a85895b50eb44220150eb4452a0000a",
                "id": "cash",
                "name": "Cash",
                "creationDate": "2015-11-09T08:02:14+0000",
                "index": 0,
                "activated": true,
                "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
                "savingsConstraints": {
                    "encodedKey": "8a858f9c5ac133f9015ac1345f780061",
                    "filterConstraints": []
                },
                "usageRights": {
                    "encodedKey": "8a85895b50eb44220150eb4452a1000b",
                    "isAccessibleByAllUsers": true,
                    "roles": []
                }
            }
        },
        "userKey": "8a85895b50eb44220150eb442cdb0004",
        "branchKey": "8a858f23573921ad01574d656b6538ae",
        "centreKey": "8a858f23573921ad01574d67c02e3952",
        "savingsPredefinedFeeAmounts": [],
        "productTypeKey": "8a858f545908094b015921ef648252c7",
        "currencyCode": "USD",
        "customInformation": [
            {
                "encodedKey": "8a858f145f489bdb015f49e0ee871d59",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a210e135c",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a210e135c",
                    "id": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                    "creationDate": "2017-05-31T08:19:22+0000",
                    "lastModifiedDate": "2017-05-31T08:19:22+0000",
                    "name": "Bank #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 1,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135d",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135f",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "Bank of America",
                "indexInList": -1,
                "customFieldID": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e0ee871d5a",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a21131362",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21131362",
                    "id": "RECEPIT_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:33+0000",
                    "lastModifiedDate": "2017-05-31T08:19:33+0000",
                    "name": "Receipt #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 2,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21131363",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21131364",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "1234",
                "indexInList": -1,
                "customFieldID": "RECEPIT_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e0ee871d5b",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a21171368",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21171368",
                    "id": "CHECK_NUMBER_TRANSACTION_CHANNEL",
                    "creationDate": "2017-05-31T08:19:40+0000",
                    "lastModifiedDate": "2017-05-31T08:19:40+0000",
                    "name": "Check #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 3,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21171369",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a2117136a",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "332",
                "indexInList": -1,
                "customFieldID": "CHECK_NUMBER_TRANSACTION_CHANNEL",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e0ee871d5c",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a211c136c",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a211c136c",
                    "id": "ACCOUNT_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:46+0000",
                    "lastModifiedDate": "2017-05-31T08:19:46+0000",
                    "name": "Account #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 4,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a211d136d",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a211d136e",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "44a442c",
                "indexInList": -1,
                "customFieldID": "ACCOUNT_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e268eb1dc1",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a21241373",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a21241373",
                    "id": "ACCOUNT_NAME_TRANSACTION_CHANNEL",
                    "creationDate": "2017-05-31T08:19:51+0000",
                    "lastModifiedDate": "2017-05-31T08:19:51+0000",
                    "name": "Account Name",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 5,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21241374",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a21241375",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "NameExample",
                "indexInList": -1,
                "customFieldID": "ACCOUNT_NAME_TRANSACTION_CHANNEL",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e268eb1dc2",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a85898b548f54af01548f6a212a137a",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a212a137a",
                    "id": "ROUTING_NUMBER_TRANSACTION_CHANN",
                    "creationDate": "2017-05-31T08:19:57+0000",
                    "lastModifiedDate": "2017-05-31T08:19:57+0000",
                    "name": "Routing #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 6,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a212a137b",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a212a137c",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "example",
                "indexInList": -1,
                "customFieldID": "ROUTING_NUMBER_TRANSACTION_CHANN",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e268eb1dc3",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a858f145f489bdb015f49df74191ce3",
                "customField": {
                    "encodedKey": "8a858f145f489bdb015f49df74191ce3",
                    "id": "TTFC1",
                    "creationDate": "2017-10-23T15:36:23+0000",
                    "lastModifiedDate": "2017-10-23T15:36:59+0000",
                    "name": "TestTransactionCustomfield1",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce2",
                        "id": "TETF",
                        "name": "Test Extra Transaction Fields",
                        "notes": "",
                        "createdDate": "2017-10-23T15:36:10+0000",
                        "indexInList": 1,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 7,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce4",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b02c1d3a",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "CustomFieldValue1",
                "indexInList": -1,
                "customFieldID": "TTFC1",
                "customFieldSetGroupIndex": -1
            },
            {
                "encodedKey": "8a858f145f489bdb015f49e268eb1dc4",
                "parentKey": "8a858f145f489bdb015f49df74191ce0",
                "customFieldKey": "8a858f145f489bdb015f49e0b0331d41",
                "customField": {
                    "encodedKey": "8a858f145f489bdb015f49e0b0331d41",
                    "id": "TTFC2",
                    "creationDate": "2017-10-23T15:36:39+0000",
                    "lastModifiedDate": "2017-10-23T15:36:39+0000",
                    "name": "TestTransactionCustomfield2",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "NUMBER",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a858f145f489bdb015f49df74191ce2",
                        "id": "TETF",
                        "name": "Test Extra Transaction Fields",
                        "notes": "",
                        "createdDate": "2017-10-23T15:36:10+0000",
                        "indexInList": 1,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 8,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b0331d42",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a858f145f489bdb015f49e0b0331d43",
                        "isAccessibleByAllUsers": false,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "30",
                "indexInList": -1,
                "customFieldID": "TTFC2",
                "customFieldSetGroupIndex": -1
            }
        ]
    }
]

POST Transactions

Allows for posting transaction to the account. Transactions may affect the balance (such as a deposit or withdrawal.).
  • FEE - Apply arbitrary or predefined fee
  • The date of the transaction - used for backdating transactions. Can have date format yyyy-MM-dd, date time format yyyy-MM-dd'T'HH:mm:ss in UTC and specified timezone yyyy-MM-dd'T'HH:mm:ssZ. Unique optional identifier. There can't be more than one transaction (loan or savings) posted with the same identifier.
    type Type of the transaction. Required.
    • DEPOSIT - Make a deposit
    • WITHDRAWAL - Make a withdrawal.
    • APPROVAL - Change the account state to approve.
    • UNDO_APPROVAL - change the account state from approved to pending approval
    • TRANSFER - Make a transfer, it can be done between different clients
    • FEE - Apply arbitrary fee
    • REJECT - Change the account state to rejected.
    • WITHDRAW - Close the account.
    • CLOSE - Close the account. Requires the account to have 0 balance.
    • TRANSFER_ADJUSTMENT. Reverses a transfer transaction.
    • WITHDRAWAL_ADJUSTMENT. Reverses a withdrawal transaction.
    • DEPOSIT_ADJUSTMENT. Reverses a previous deposit.
    • FEE_ADJUSTED. Reverses a previous applied fee.
    • START_MATURITY - Start the maturity period of the account.
    amount The amount in the local currency of the transaction. Required.
    toSavingsAccount For TRANSFER transaction types, the destination savings account to make a deposit to.
    toLoanAccount For TRANSFER transactions types, the destination loan account to make the repayment to.
    date The date of the transaction - used for backdating transactions. Can have date format yyyy-MM-dd, date time format yyyy-MM-dd'T'HH:mm:ss in UTC and specified timezone yyyy-MM-dd'T'HH:mm:ssZ.
    method The transaction channel id/key of method use for the transaction. If none provided the default one will be used.
    notes Optional notes to record for this transaction.

    Parameters for Custom Fields

    Available only for transactions which accepts channels: DEPOSIT and WITHDRAWAL. Provided fields must be available for the given channel and required validation is done based on field settings.
    customFieldID The custom field Id. Required.
    value The custom field Value. Required.
    URL
    //undo approve account using url-encoded call(id is used for account identification)
    POST "type=UNDO_APPROVAL" /api/savings/67/transactions/
    
    //post a deposit of 10 to account KHGJ593
    POST "type=DEPOSIT&amount=10" /api/savings/KHGJ593/transactions
    
    //post a deposit of 10 to account KHGJ593 using transaction channel with the id "ntc"
    POST "type=DEPOSIT&amount=10&method=ntc" /api/savings/KHGJ593/transactions
    
    //post a deposit of 10 to account KHGJ593 using transaction channel with the key 40288a134744a69a014748589b7e0005
    POST "type=DEPOSIT&amount=10&method=40288a134744a69a014748589b7e0005&notes=post a withdrawal of 50 with some notes" /api/savings/KHGJ593/transactions
    
    //post a backdated deposit of 10 on 2011-09-12 at 11:47 to account KHGJ593
    POST "type=DEPOSIT&amount=10&date=2011-09-12T11:47:51" /api/savings/KHGJ593/transactions
    
    //post a backdated deposit of 10 with timestamp and timezone(UTC+1) specified
    POST "type=DEPOSIT&amount=10&date=2011-09-12T11:47:51+0100" /api/savings/KHGJ593/transactions
    
    //post a withdrawal of 50 with some notes
    POST "type=WITHDRAWAL&amount=50&notes=with tens" /api/savings/KHGJ593/transactions
    
    //post a transfer of 10 from account KHGJ593 to loan account with ABC123. The accounts can belong to different clients.
    POST "type=TRANSFER&toLoanAccount=ABC123&amount=10" /api/savings/KHGJ593/transactions
    
    //post a transfer of 15.50 from account KHGJ593 to loan with key 8a5c67f3337b4be401338f447441272f. The accounts can belong to different clients.
    POST "type=TRANSFER&toLoanAccount=8a5c67f3337b4be401338f447441272f&amount=15.5&notes=oranges" /api/savings/KHGJ593/transactions
    
    //post - apply a fee on savings account with id KHGJ593
    POST "type=FEE&amount=10&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post - reject savings account with id KHGJ593
    POST "type=reject&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post reject savings account with id KHGJ593
    POST "type=reject&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post withdraw savings account with id KHGJ593
    POST "type=withdraw&notes=some notes" /api/savings/KHGJ593/transactions
    
    //close the savings account with ID KHGJ593
    POST 'type=CLOSE&notes=account closed via API'; /api/savings/KHGJ593/transactions
    
    //post a transaction reversal
    POST "type=transfer_adjustment&originalTransactionId=99&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post a withdrawal reversal
    POST "type=withdrawal_adjustment&originalTransactionId=98&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post a deposit reversal
    POST "type=deposit_adjustment&originalTransactionId=97&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post a fee reversal
    POST "type=fee_adjusted&originalTransactionId=97&notes=some notes" /api/savings/KHGJ593/transactions
    
    //post start maturity for account with id KHGJ593
    POST "type=start_maturity&date=2011-09-12&notes=some notes" /api/savings/KHGJ593/transactions
    

    JSON
    //approve account using url-encoded call(id is used for account identification)
    POST '{
        "type": "APPROVAL"
    }' /api/savings/67/transactions/
    
    //undo approve account using url-encoded call(id is used for account identification)
    POST '{
        "type": "UNDO_APPROVAL"
    }' /api/savings/67/transactions/
    
    //post a deposit of 10 to account KHGJ593
    POST '{
        "type": "DEPOSIT",
        "amount": "10"
    }' /api/savings/KHGJ593/transactions
    
    //post a deposit of 10 to account KHGJ593 using transaction channel with ntc id and bankRoutingNumber AU11234
    POST '{
        "type": "DEPOSIT",
        "amount": "10",
        "method": "ntc",
        "customInformation": [
          {
              "value":"bank number example",
              "customFieldID":"BANK_NUMBER_TRANSACTION_CHANNEL_"
           }
    
        ]
    }' /api/savings/KHGJ593/transactions
    
    //post a deposit of 10 to account KHGJ593 using transaction channel with 40288a134744a69a014748589b7e0005 key/code
    POST '{
        "type": "DEPOSIT",
        "amount": "10",
        "method": "40288a134744a69a014748589b7e0005",
        "customInformation": [
          {
              "value":"bank number example",
              "customFieldID":"BANK_NUMBER_TRANSACTION_CHANNEL_"
           }
    
        ]
    }' /api/savings/KHGJ593/transactions
    
    //post a backdated deposit of 10 on 2011-09-12 at 11:47 to account KHGJ593
    POST '{
        "type": "DEPOSIT",
        "amount": "10",
        "date": "2011-05-01T11:38:00"
    }' /api/savings/KHGJ593/transactions
    
        //post a withdrawal of 50 with some notes
        POST '{
        "type": "WITHDRAWAL",
        "amount": "50",
        "notes": "with tens"
    }' /api/savings/KHGJ593/transactions
    
    //post a transfer of 10 from account KHGJ593 to loan account with ABC123. The accounts can belong to different clients.
    POST '{
        "type": "TRANSFER",
        "toLoanAccount": "ABC123",
        "amount": "10"
    }' /api/savings/KHGJ593/transactions
    
    //post a transfer of 15.50 from account KHGJ593 to loan with key 8a5c67f3337b4be401338f447441272f. The accounts can belong to different clients.
    POST '{
        "type": "TRANSFER",
        "toLoanAccount": "8a5c67f3337b4be401338f447441272f",
        "amount": "15.5",
        "notes": "oranges"
    }' /api/savings/KHGJ593/transactions
    
    //post predefined savings fee for savings account with id KHGJ593
    POST '{  
       "type":"FEE",
       "fees":[  
          {  
             "encodedKey":"ff808081533b9be301533ba7aa5d0378"
          }
       ],
       "notes":"test"
    }' /api/savings/KHGJ593/transactions
    
    //post custom predefined savings fee for savings account with id KHGJ593
    POST '{  
       "type":"FEE",
       "fees":[  
          {  
             "encodedKey":"ff808081533b9be301533ba7aa5d0378",
             "amount":"10"
          }
       ],
       "notes":"test"
    }' /api/savings/KHGJ593/transactions
    
    POST '{
        "type": "REJECT",
        "notes": "not approved by analyst"
    }' /api/savings/KHGJ593/transactions
    
    //post withdraw savings account with id KHGJ593
    POST '{
        "type": "WITHDRAW",
        "notes": "client withdrew her application"
    }' /api/savings/KHGJ593/transactions
    
    //post close savings account with id KHGJ593
    POST '{
        "type": "CLOSE",
        "notes": "account closed due to inactivity."
    }' /api/savings/KHGJ593/transactions
    
    //post a transaction reversal
    POST '{
        "type": "TRANSFER_ADJUSTMENT",
        "originalTransactionId": "98",
        "notes": "cancel incorrect charge"
    }' /api/savings/KHGJ593/transactions
    
    //post a withdrawal reversal
    POST '{
        "type": "WITHDRAWAL_ADJUSTMENT",
        "originalTransactionId": "97",
        "notes": "cancel incorrect withdrawal"
    }' /api/savings/KHGJ593/transactions
    
    //post a deposit reversal
    POST '{
        "type": "DEPOSIT_ADJUSTMENT",
        "originalTransactionId": "99",
        "notes": "cancel incorrect deposit"
    }' /api/savings/KHGJ593/transactions
    
    // add a withdrawal transaction with custom fields for the savings account with id YT97L1
    POST '{
       "type":"WITHDRAWAL",
       "amount":"200",
       "method":"cash",
       "customInformation": [
            {
                "value":"3333se",
                "customFieldID":"transaction_cf"
            }
        ]
    }' /api/savings/YT97L1/transactions
    
    //post a fee reversal
    POST '{
        "type": "FEE_ADJUSTED",
        "originalTransactionId": "99",
        "notes": "cancel incorrect fee"
    }' /api/savings/KHGJ593/transactions
    
    //post start maturity
    POST '{
        "type": "START_MATURITY",
        "date": "2017-11-15",
        "notes": "start maturity for the account with id KHGJ593"
    }' /api/savings/KHGJ593/transactions
    
    //post start maturity without date
    POST '{
        "type": "START_MATURITY",
        "notes": "start maturity for the account with id KHGJ593"
    }' /api/savings/KHGJ593/transactions
    

    Samples responses:

    A 201 code is returned along with created transaction. The transaction id is also stored in the Location header.
    
    {
        "encodedKey": "8a858efb5f487eb5015f4d508fee6b84",
        "transactionId": 87,
        "parentAccountKey": "8a858f145f489bdb015f49ded8ea1caf",
        "type": "DEPOSIT",
        "creationDate": "2017-10-24T07:37:26+0000",
        "entryDate": "2017-10-24T07:37:26+0000",
        "amount": "10",
        "interestAmount": "0",
        "feesAmount": "0",
        "overdraftAmount": "0",
        "fundsAmount": "10",
        "feesPaid": "0",
        "interestPaid": "0",
        "balance": "31",
        "details": {
            "encodedKey": "8a858efb5f487eb5015f4d508fee6b85",
            "transactionChannelKey": "8a858fb85f488d38015f496010a35c44",
            "internalTransfer": false,
            "transactionChannel": {
                "encodedKey": "8a858fb85f488d38015f496010a35c44",
                "id": "ntc",
                "name": "tr",
                "createdByUserKey": "8a85895b50eb44220150eb442cdb0004",
                "creationDate": "2017-10-23T13:15:53+0000",
                "index": 2147483647,
                "activated": true,
                "savingsConstraintsUsage": "UNCONSTRAINED_USAGE",
                "savingsConstraints": {
                    "encodedKey": "8a858fb85f488d38015f496010a35c46",
                    "filterConstraints": []
                },
                "usageRights": {
                    "encodedKey": "8a858fb85f488d38015f496010a35c45",
                    "isAccessibleByAllUsers": false,
                    "roles": [
                        "8a858e335d1dd902015d2b41fb56423b",
                        "8a858e9b560bbd63015611e7885f1475",
                        "8a858e6a5b814a98015b816ac8ae11e9"
                    ]
                }
            }
        },
        "userKey": "8a85895b50eb44220150eb442cdb0004",
        "branchKey": "8a858f23573921ad01574d656b6538ae",
        "centreKey": "8a858f23573921ad01574d67c02e3952",
        "savingsPredefinedFeeAmounts": [],
        "productTypeKey": "8a858f545908094b015921ef648252c7",
        "currencyCode": "USD",
        "customInformation": [
            {
                "encodedKey": "8a858efb5f487eb5015f4d508fee6b86",
                "parentKey": "8a858efb5f487eb5015f4d508fee6b84",
                "customFieldKey": "8a85898b548f54af01548f6a210e135c",
                "customField": {
                    "encodedKey": "8a85898b548f54af01548f6a210e135c",
                    "id": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                    "creationDate": "2017-05-31T08:19:22+0000",
                    "lastModifiedDate": "2017-10-24T07:37:23+0000",
                    "name": "Bank #",
                    "type": "TRANSACTION_CHANNEL_INFO",
                    "dataType": "STRING",
                    "valueLength": "SHORT",
                    "isDefault": false,
                    "isRequired": false,
                    "description": "",
                    "customFieldSet": {
                        "encodedKey": "8a85898b548f54af01548f6a20e01341",
                        "id": "Transaction_Details_Transactions",
                        "name": "Transaction Details",
                        "notes": "Captures default transaction custom fields",
                        "createdDate": "2016-05-08T08:09:38+0000",
                        "indexInList": 0,
                        "type": "TRANSACTION_CHANNEL_INFO",
                        "usage": "SINGLE"
                    },
                    "indexInList": 1,
                    "state": "NORMAL",
                    "customFieldSelectionOptions": [],
                    "viewRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135d",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "editRights": {
                        "encodedKey": "8a85898b548f54af01548f6a210f135f",
                        "isAccessibleByAllUsers": true,
                        "roles": []
                    },
                    "unique": false,
                    "values": [],
                    "amounts": {}
                },
                "value": "bank number example",
                "indexInList": -1,
                "customFieldID": "BANK_NUMBER_TRANSACTION_CHANNEL_",
                "customFieldSetGroupIndex": -1
            }
        ]
    } "productTypeKey":"40288a134744047801474404dc140336"
    

    PATCH Savings Transaction Custom Field Values

    Custom field values for a savings transaction can be added/edited using PATCH method. The new custom field value is validated based on the custom field type defined in the Custom Field.

    Parameters for PATCH custom fields method for savings transaction

    value New value for the custom field. Required.

    Usage Example

    // Update the custom field value to "10" based on the savings id(abc123), transaction id(100) and on the custom field id(members)
    PATCH '{ "value": "10" }' /api/savings/abc123/transactions/100/custominformation/members
    
    // Update the custom field value to "2012-10-10" based on the savings key(40288a134887e7e9014887f0eb720003), transaction key(8a27a878491d417601491d48203100d8) and on the custom field key(8a27a878491d417601491d48203100d9)
    PATCH '{ "value": "2012-10-10" }' /api/savings/40288a134887e7e9014887f0eb720003/transactions/8a27a878491d417601491d48203100d8/custominformation/8a27a878491d417601491d48203100d9
    
    // Update(add / edit) multiple grouped and / or standard fields from different groups for the savings transaction with the id 100 from the account with the id abc123. For a grouped custom field, if customFieldSetGroupIndex is present, value is updated, if is missing, a new group is created. 
    PATCH '{
      "customInformation": [
        {
          "customFieldID" : "IBAN",
          "value" : "DE123456789121243546783"
        },
        {
          "customFieldID" : "BIC",
          "value" : "1234566441",
          "customFieldSetGroupIndex" : "0"
        },
        {
          "customFieldID" : "BANK_ACCOUNT_TYPE",
          "value" : "Current Account",
          "customFieldSetGroupIndex" : "1"
        }
      ]
    }' /api/savings/abc123/transactions/100/custominformation
    

    Response

    A 200 Response is returned if the savings transaction custom field value was successfully created/updated.

    GET Savings Transaction Custom Field Values

    Allows retrieving a custom field value for a given savings transaction directly by the ID/key of the transaction and the ID/key of the custom field.

    Usage Example

    //get the custom field value of the custom field with the ID "family_members" for the savings transaction having ID "abc123" posted on the savings account "account11"
    GET /api/savings/account11/transactions/abc123/custominformation/family_members
    //get the custom field value of the custom field with the encoded key "8a8080a254a98efe0154a99ad9d301be" for the savings transaction having key "8a8080a254a98efe0154a99ad8c400f6" posted on the savings account "8a8080a254a98efe0154a99ad9d301be"
    GET /api/savings/8a8080a254a98efe0154a99ad9d301be/transactions/8a8080a254a98efe0154a99ad8c400f6/custominformation/8a8080a254a98efe0154a99ad86f00ef
    
    

    Response

    //response for a single custom field
    [
      {
        "encodedKey": "8a8080a254a98efe0154a99ad9d301be",
        "parentKey": "8a8080a254a98efe0154a99ad8c400f6",
        "customFieldKey": "8a8080a254a98efe0154a99ad86f00ef",
        "customField": {
          "encodedKey": "8a8080a254a98efe0154a99ad86f00ef",
          "id": "Position_Clients",
          "creationDate": "2016-05-18T14:39:13+0000",
          "lastModifiedDate": "2016-05-18T14:40:19+0000",
          "name": "Position",
          "type": "TRANSACTION_CHANNEL_INFO",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a8080a254a98efe0154a99ad84200ee",
            "name": "Custom Fields",
            "createdDate": "2016-05-13T10:12:58+0000",
            "indexInList": 0,
            "type": "TRANSACTION_CHANNEL_INFO",
            "usage": "SINGLE"
          },
          "indexInList": 3,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a8080a254a98efe0154a99ad87200f0",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a8080a254a98efe0154a99ad87300f1",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "Promotions manager",
        "indexInList": 0,
        "customFieldID": "Position_Clients",
        "customFieldSetGroupIndex": -1
      }
    ]
    //response for a grouped custom field
    [
      {
        "encodedKey": "8a8080a254c4397d0154c450f88d0034",
        "parentKey": "8a8080a254a98efe0154a99ad8c800fa",
        "customFieldKey": "8a8080a254c4397d0154c45093f4002a",
        "customField": {
          "encodedKey": "8a8080a254c4397d0154c45093f4002a",
          "id": "ccc1",
          "creationDate": "2016-05-18T14:41:36+0000",
          "lastModifiedDate": "2016-05-18T14:41:36+0000",
          "name": "cccc1",
          "type": "TRANSACTION_CHANNEL_INFO",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a8080a254c4397d0154c450633e0029",
            "name": "groupedcfs",
            "notes": "",
            "createdDate": "2016-05-18T14:41:23+0000",
            "indexInList": 2,
            "type": "TRANSACTION_CHANNEL_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 14,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002b",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002c",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "111",
        "indexInList": 0,
        "customFieldID": "ccc1",
        "customFieldSetGroupIndex": 0
      },
      {
        "encodedKey": "8a8080a254c4397d0154c4545f410037",
        "parentKey": "8a8080a254a98efe0154a99ad8c800fa",
        "customFieldKey": "8a8080a254c4397d0154c45093f4002a",
        "customField": {
          "encodedKey": "8a8080a254c4397d0154c45093f4002a",
          "id": "ccc1",
          "creationDate": "2016-05-18T14:41:36+0000",
          "lastModifiedDate": "2016-05-18T14:41:36+0000",
          "name": "cccc1",
          "type": "TRANSACTION_CHANNEL_INFO",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a8080a254c4397d0154c450633e0029",
            "name": "groupedcfs",
            "notes": "",
            "createdDate": "2016-05-18T14:41:23+0000",
            "indexInList": 2,
            "type": "TRANSACTION_CHANNEL_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 14,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002b",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002c",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "222",
        "indexInList": 2,
        "customFieldID": "ccc1",
        "customFieldSetGroupIndex": 1
      },
      {
        "encodedKey": "8a8080a254c4397d0154c4545f410039",
        "parentKey": "8a8080a254a98efe0154a99ad8c800fa",
        "customFieldKey": "8a8080a254c4397d0154c45093f4002a",
        "customField": {
          "encodedKey": "8a8080a254c4397d0154c45093f4002a",
          "id": "ccc1",
          "creationDate": "2016-05-18T14:41:36+0000",
          "lastModifiedDate": "2016-05-18T14:41:36+0000",
          "name": "cccc1",
          "type": "TRANSACTION_CHANNEL_INFO",
          "dataType": "STRING",
          "valueLength": "SHORT",
          "isDefault": false,
          "isRequired": false,
          "description": "",
          "customFieldSet": {
            "encodedKey": "8a8080a254c4397d0154c450633e0029",
            "name": "groupedcfs",
            "notes": "",
            "createdDate": "2016-05-18T14:41:23+0000",
            "indexInList": 2,
            "type": "TRANSACTION_CHANNEL_INFO",
            "usage": "GROUPED"
          },
          "indexInList": 14,
          "state": "NORMAL",
          "customFieldSelectionOptions": [],
          "viewRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002b",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "editRights": {
            "encodedKey": "8a8080a254c4397d0154c45093f4002c",
            "isAccessibleByAllUsers": false,
            "roles": []
          },
          "unique": false,
          "values": [],
          "amounts": {}
        },
        "value": "333",
        "indexInList": 4,
        "customFieldID": "ccc1",
        "customFieldSetGroupIndex": 2
      }
    ]
    
    

    DELETE Savings Transaction Custom Field Values

    Specific custom field values for a savings transaction can be deleted based on savings account id, transaction id and custom field id.

    Usage Example

    // DELETE the custom field value based on the savings id(abc123), transaction id (100) and on the custom field id(members)
    DELETE /api/savings/abc123/transactions/100/custominformation/members
    
    // DELETE the custom field value based on the savings key(40288a134887e7e9014887f0eb720003), transaction key(8a27a878491d417601491d48203100d8) and on the custom field key(8a27a878491d417601491d48203100d9)
    DELETE /api/savings/40288a134887e7e9014887f0eb720003/transactions/8a27a878491d417601491d48203100d8/custominformation/8a27a878491d417601491d48203100d9
    

    Response

    A 200 Response is returned if the savings transaction custom field value was successfully deleted.

    POST Search

    Allows to retrieve transactions using dynamic custom filters.

    Parameters

    Parameter Value
    filterConstraints A JSON array of constraints.
    filterSelection The field on which the constraint will be applied. Available transaction filter selections can be found bellow.
    filterElement The constraint operator. Available filter elements can be found bellow.
    value The constraint value. Required for filter elements with one or two values.
    secondValue The constraint second value. Required for filter elements with two values.
    dataItemType The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional.

    Available transaction filter values

    Filter Selection Parameter Data Type
    PARENT_ACCOUNT_KEY KEY
    PRODUCT_TYPE_KEY KEY
    USER_KEY KEY
    BRANCH_KEY KEY
    CENTRE_KEY KEY
    PARENT_ACCOUNT_HOLDER_KEY KEY
    CURRENCY_CODE KEY
    PRODUCT_ID STRING
    WAS_REVERSED BOOLEAN
    TYPE_IS_REVERSAL BOOLEAN
    INTERNAL_TRANSFER BOOLEAN
    TRANSACTION_CHANNEL_KEY KEY
    ENCODED_KEY KEY
    TRANSACTION_ID LONG
    TILL_ID STRING
    ENTRY_DATE DATE
    TRANSACTION_DATE DATE_UTC
    EVENT ENUM
    AMOUNT MONEY
    ADVANCE_POSITION MONEY
    ARREARS_POSITION MONEY
    EXPECTED_PRINCIPAL_REDRAW MONEY
    ORIGINAL_AMOUNT MONEY
    ORIGINAL_AMOUNT_CURRENCY_CODE STRING
    BALANCE (Deprecated. Use TOTAL_BALANCE) MONEY
    TOTAL_BALANCE MONEY
    PRINCIPAL_BALANCE MONEY
    REDRAW_BALANCE MONEY
    PRINCIPAL_PAID MONEY
    INTEREST_PAID MONEY
    DEFERRED_INTEREST MONEY
    FEES_PAID MONEY
    FEE_KEY KEY
    FEE_TYPE ENUM
    PENALTY_PAID MONEY
    BRANCH STRING
    CENTRE STRING
    PARENT_ACCOUNT STRING
    PARENT_ACCOUNT_ID STRING
    PARENT_ACCOUNT_HOLDER STRING
    PARENT_ACCOUNT_HOLDER_ID STRING
    TAX_RATE BIG_DECIMAL
    TAX_AMOUNT MONEY
    INTEREST_RATE BIG_DECIMAL
    PRINCIPAL_PAYMENT_FLAT_AMOUNT MONEY
    PRINCIPAL_PAYMENT_PERCENTAGE BIG_DECIMAL
    OVERDRAFT_INTEREST_RATE BIG_DECIMAL
    OVERDRAFT_LIMIT MONEY

    Available filter elements

    Filter Element Number Of affected values Available for
    EQUALS ONE_VALUE BIG_DECIMAL,BOOLEAN,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY
    MORE_THAN ONE_VALUE BIG_DECIMAL,NUMBER,MONEY
    LESS_THAN ONE_VALUE BIG_DECIMAL,NUMBER,MONEY
    BETWEEN TWO_VALUES BIG_DECIMAL,NUMBER,MONEY,DATE,DATE_UTC
    ON ONE_VALUE DATE,DATE_UTC
    AFTER ONE_VALUE DATE,DATE_UTC
    BEFORE ONE_VALUE DATE,DATE_UTC
    STARTS_WITH ONE_VALUE STRING
    IN LIST ENUM,KEY
    TODAY NO_VALUE DATE,DATE_UTC
    THIS_WEEK NO_VALUE DATE,DATE_UTC
    THIS_MONTH NO_VALUE DATE,DATE_UTC
    THIS_YEAR NO_VALUE DATE,DATE_UTC
    LAST_DAYS ONE_VALUE DATE,DATE_UTC
    EMPTY NO_VALUE BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC
    NOT_EMPTY NO_VALUE BIG_DECIMAL,LONG,MONEY,NUMBER,PERCENT,STRING,ENUM,KEY,DATE,DATE_UTC

    Usage examples

    // get the deposit transaction with ID 58, together with all customfields related to it"
        POST {
          "filterConstraints":[
              {
              "filterSelection":"TRANSACTION_ID",
              "filterElement":"EQUALS",
              "value":"58"
              }
          ]
        } /api/savings/transactions/search

    Response

    
    
    The transaction that matches the search will be returned
    [ { "encodedKey": "8a858e195b90e512015b9f65f6b263d8", "transactionId": 58, "parentAccountKey": "8a858e8a575612610157708b40194c20", "type": "WITHDRAWAL", "comment": "This is a comment", "creationDate": "2017-04-24T09:59:13+0000", "entryDate": "2017-04-24T09:59:13+0000", "amount": "-34", "interestAmount": "0", "feesAmount": "0", "overdraftAmount": "0", "fundsAmount": "34", "feesPaid": "0", "interestPaid": "0", "balance": "990761", "details": { "encodedKey": "8a858e195b90e512015b9f65f6b263d9", "transactionChannelKey": "8a85895b50eb44220150eb4452a0000a", "identifier": "123123123", "internalTransfer": false, "transactionChannel": { "encodedKey": "8a85895b50eb44220150eb4452a0000a", "id": "cash", "name": "Cash", "creationDate": "2015-11-09T08:02:14+0000", "index": 0, "activated": true, "savingsConstraintsUsage": "UNCONSTRAINED_USAGE", "savingsConstraints": { "encodedKey": "8a858f9c5ac133f9015ac1345f780061", "filterConstraints": [] }, "usageRights": { "encodedKey": "8a85895b50eb44220150eb4452a1000b", "isAccessibleByAllUsers": true, "roles": [] } } }, "userKey": "8a85895b50eb44220150eb442cdb0004", "reversalTransactionKey": "8a858e195b90e512015b9f65f6b263db", "savingsPredefinedFeeAmounts": [], "productTypeKey": "8a858e1e54e2aa5a0154e796336f5c11", "currencyCode": "USD", "customInformation": [ { "encodedKey": "8a858e195b90e512015b9f65f6b263da", "parentKey": "8a858e195b90e512015b9f65f6b263d8", "customFieldKey": "8a85898b548f54af01548f6a20fd1353", "customField": { "encodedKey": "8a85898b548f54af01548f6a20fd1353", "id": "IDENTIFIER_TRANSACTION_CHANNEL_I", "creationDate": "2016-09-22T14:07:31+0000", "lastModifiedDate": "2017-02-22T15:34:53+0000", "name": "Identifier", "type": "TRANSACTION_CHANNEL_INFO", "dataType": "STRING", "valueLength": "SHORT", "isDefault": false, "isRequired": false, "description": "An unique user-defined identifier for each transaction. This field is optional, but if specified, it must be unique across all loan and deposit transactions", "customFieldSet": { "encodedKey": "8a85898b548f54af01548f6a20e01341", "name": "Transaction Details", "notes": "Captures default transaction custom fields", "createdDate": "2016-05-08T08:09:38+0000", "indexInList": 0, "type": "TRANSACTION_CHANNEL_INFO", "usage": "SINGLE" }, "indexInList": 0, "state": "NORMAL", "customFieldSelectionOptions": [], "viewRights": { "encodedKey": "8a85898b548f54af01548f6a20fd1354", "isAccessibleByAllUsers": true, "roles": [] }, "editRights": { "encodedKey": "8a85898b548f54af01548f6a21001358", "isAccessibleByAllUsers": true, "roles": [] }, "unique": false, "values": [], "amounts": {} }, "value": "123123123", "indexInList": -1, "customFieldID": "IDENTIFIER_TRANSACTION_CHANNEL_I", "customFieldSetGroupIndex": -1 } ] } ]
    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