diff --git a/api-docs/apiLive.htm b/api-docs/apiLive.htm
index c2fa3283c..3139b1a5b 100644
--- a/api-docs/apiLive.htm
+++ b/api-docs/apiLive.htm
@@ -3312,6 +3312,38 @@
|
|
+
+ | Beneficiary for Third Party Transfer |
+ /self/beneficiaries/tpt/template |
+ |
+ Beneficiary TPT Template |
+ |
+ |
+
+
+ |
+ /self/beneficiaries/tpt |
+ Add TPT Beneficiary |
+ Get TPT Beneficiary List |
+ Update TPT Beneficiary |
+ Delete TPT Beneficiary |
+
+
+ | Third Party Account Transfers |
+ self/accounttransfers/template?type="tpt" |
+ |
+ Third Party Account Transfer Template |
+ |
+ |
+
+
+ |
+ self/accounttransfers?type="tpt" |
+ Third Party Account Transfer |
+ |
+ |
+ |
+
@@ -42193,7 +42225,35 @@ GET https://DomainName/api/v1/self/savingsaccounts/{accountId}/charges/{savingsA
{
- "accountOptions": [
+ "fromAccountOptions": [
+ {
+ "accountId": 1,
+ "accountNo": "00000001",
+ "accountType": {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ "clientId": 1,
+ "clientName": "ABC",
+ "officeId": 1,
+ "officeName": "HEAD OFFICE"
+ },
+ {
+ "accountId": 5,
+ "accountNo": "00000005",
+ "accountType": {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ },
+ "clientId": 2,
+ "clientName": "XYZ",
+ "officeId": 3,
+ "officeName": "REGIONAL OFFICE"
+ }
+ ],
+ "toAccountOptions": [
{
"accountId": 1,
"accountNo": "00000001",
@@ -42221,6 +42281,7 @@ GET https://DomainName/api/v1/self/savingsaccounts/{accountId}/charges/{savingsA
"officeName": "REGIONAL OFFICE"
}
]
+
}
@@ -42262,6 +42323,322 @@ No Request Body:
+
+
+
+
Beneficiary Third Party Transfer Template
+
Returns Account Type enumerations. Self User is expected to know office name and account number to be able to add beneficiary.
+
Example Requests:
+
/self/beneficiaries/tpt/template
+
+
+ GET https://DomainName/api/v1/self/beneficiaries/tpt/template
+
+
+ {
+ "accountTypeOptions":
+ [
+ {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ }
+ ]
+ }
+
+
+
+
+
Add TPT Beneficiary
+
Api to add third party beneficiary linked to current user.
+
Parameter Definitions
+
name : Nick name for beneficiary, should be unique for an self service user
+
officeName : Office Name of beneficiary(not id)
+
accountNumber : Account Number of beneficiary(not id)
+
transferLimit : Each transfer initiated to this account will not exceed this amount
+
Example Requests:
+
/self/beneficiaries/tpt
+
+
+ Mandatory Fields |
+
+
+ | name, officeName, accountNumber, accountType |
+
+
+
+
+
+ Optional Fields |
+
+
+ | transferLimit
+ |
+
+
+
+
+
+ POST https://DomainName/api/v1/self/beneficiaries/tpt
+
+
+POST self/beneficiaries/tpt
+Content-Type: application/json
+Request Body:
+{
+ "locale": "en_GB",
+ "name": "beneficiary nick name",
+ "officeName": "HEAD OFFICE",
+ "accountNumber": "0000001",
+ "accountType": 1,
+ "transferLimit": 1000
+
+}
+
+
+{
+ "resourceId": 5
+}
+
+
+
+
+
Get All TPT Beneficiary
+
Api to get all third party beneficiary linked to current user.
+
Example Requests:
+
/self/beneficiaries/tpt
+
+
+
+ GET https://DomainName/api/v1/self/beneficiaries/tpt
+
+
+GET self/beneficiaries/tpt
+Content-Type: application/json
+
+
+{
+[
+ {
+ "id": 1,
+ "name": "Client2Savings",
+ "officeName": "Test Office",
+ "clientName": "FN2 LN2",
+ "accountType": {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ "accountNumber": "000000002",
+ "transferLimit": 0
+ },
+ {
+ "id": 4,
+ "name": "Client2Loan",
+ "officeName": "Test Office",
+ "clientName": "FN2 LN2",
+ "accountType": {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ },
+ "accountNumber": "000000002",
+ "transferLimit": 1000
+ }]
+}
+
+
+
+
+
Update TPT Beneficiary
+
Api to update third party beneficiary linked to current user.
+
Example Requests:
+
/self/beneficiaries/tpt/{beneficiaryId}
+
+
+
+ Optional Fields |
+
+
+ | name, transferLimit
+ |
+
+
+
+
+
+ PUT https://DomainName/api/v1/self/beneficiaries/tpt/{beneficiaryId}
+
+
+PUT self/beneficiaries/tpt/5
+Content-Type: application/json
+Request Body:
+{
+ "name": "beneficiary nick name",
+ "transferLimit": 1000
+
+}
+
+
+{
+ "resourceId": 5,
+ "changes": {
+ "transferLimit": 1000,
+ "name": "Client22"
+ }
+}
+
+
+
+
+
Delete TPT Beneficiary
+
Api to delete third party beneficiary linked to current user.
+
Example Requests:
+
/self/beneficiaries/tpt/{beneficiaryId}
+
+
+
+ DELETE https://DomainName/api/v1/self/beneficiaries/tpt/{beneficiaryId}
+
+
+DELETE self/beneficiaries/tpt/5
+Content-Type: application/json
+
+
+{
+ "resourceId": 5
+}
+
+
+
+
+
Third Party Account Transfer Template
+
Returns list of loan/savings accounts that can be used for third party account transfer
+
Example Requests:
+
self/accounttransfers/template?type="tpt"
+
+
+ GET https://DomainName/api/v1/self/accounttransfers/template?type="tpt"
+
+
+{
+ "fromAccountOptions": [
+ {
+ "accountId": 1,
+ "accountNo": "00000001",
+ "accountType": {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ "clientId": 1,
+ "clientName": "ABC",
+ "officeId": 1,
+ "officeName": "HEAD OFFICE"
+ },
+ {
+ "accountId": 5,
+ "accountNo": "00000005",
+ "accountType": {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ },
+ "clientId": 2,
+ "clientName": "XYZ",
+ "officeId": 3,
+ "officeName": "REGIONAL OFFICE"
+ }
+ ],
+ "toAccountOptions": [
+ {
+ "accountId": 2,
+ "accountNo": "00000002",
+ "accountType": {
+ "id": 2,
+ "code": "accountType.savings",
+ "value": "Savings Account"
+ },
+ "clientId": 2,
+ "clientName": "ABC",
+ "officeId": 1,
+ "officeName": "HEAD OFFICE"
+ },
+ {
+ "accountId": 6,
+ "accountNo": "00000006",
+ "accountType": {
+ "id": 1,
+ "code": "accountType.loan",
+ "value": "Loan Account"
+ },
+ "clientId": 3,
+ "clientName": "XYZ",
+ "officeId": 4,
+ "officeName": "REGIONAL OFFICE"
+ }
+ ]
+
+}
+
+
+
+
+
Third Party Account Transfer
+
Ability to create new third party transfer of monetary funds from one account to another.
+
+
+ POST https://DomainName/api/v1/self/accounttransfers?type="tpt"
+ POST self/accounttransfers?type="tpt"
+Content-Type: application/json
+No Request Body:
+{
+"fromOfficeId": 1,
+"fromClientId": 1,
+"fromAccountType": 2,
+"fromAccountId": 1,
+"toOfficeId": 1,
+"toClientId": 2,
+"toAccountType": 2,
+"toAccountId": 2,
+"dateFormat": "dd MMMM yyyy",
+"locale": "en",
+"transferDate": "01 August 2011",
+"transferAmount": "112.45",
+"transferDescription": "A description of the transfer"
+}
+
+
+{
+ "savingsId": 1,
+ "resourceId": 1
+}
+
+
+