Arrangement

Arrangements API is used to get the customer’s account related information. This information includes Account details, Balance and other interest related information. Arrangement APIs are connected to other Micro services or T24 to fetch the customer’s account details based on the user requirement.

The user must install and integrate the microservice app with the base application before consuming the Arrangement API. For more information, click here.

Name Description Introduced In
GetAccountPostLogin This API fetches all the accounts associated with the logged in customer from the associated Micro Services or T24 based on the user type. This API is invoked from client immediately after a user logs in to their account. 2020.04
GetAccountDetails This API retrieves the details of a particular account. This API in invoked from client when the user selects a particular account. 2020.04

NOTE: In this scenario, the GetAccountPostLogin API is used to fetch the account list immediately after you log in, whereas the GetAccountDetails API is used to fetch the details of a specific account in the list. The output response of the getAccountPostLogin and getAccountDetails APIs is the same as both the APIs are pointing to the same endpoint (Microservice). Therefore, when you invoke the getAccountPostLogin API, the output response of this API contains the account details also.

Closed GetAccountPostLogin
 
Description: This API fetches all the accounts associated with the logged in customer from the associated Micro Services or T24 based on the user type. This API is invoked from client immediately after a user logs in to their account.
Method: POST
URL: {base_url}/services/data/v1/RBObjects/operations/Accounts/getAccountsPostLogin
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

CustomerId

Specifies the customer ID for which the accounts must be fetched.

{
 CustomerId: "XYZ123",
}
Response:
ClosedView the Response Parameters

Accounts [ ]

Specifies the list of all the accounts and their respective details that are fetched after the user logs in.

Parameters

Accounts/accountID

Specifies the account identification number.

Accounts/accountHolder

Specifies the primary customer name.

Accounts/accountName

Specifies the name/description of the account

Accounts/accountType

Specifies the type of the account such as Savings, Checking, and so on.

Accounts/displayName

Specifies the product description of the account.

Accounts/availableBalance

Specifies the current available balance in the account.

Accounts/bankName

Specifies the branch name of the account.

Accounts/currencyCode

Specifies the account currency.

Accounts/currentBalance

Specifies the actual online balance of the account.

Accounts/dividendLastPaidAmount

Specifies the amount of interest that you paid last time.

Accounts/dividendPaidYTD

Specifies the amount of interest paid by the account.

Accounts/dividendRate

Specifies the interest rate of the account.

Accounts/jointHolders

Specifies the name of the joint owner/secondary holder of the account.

Accounts/lastPaymentDate

Specifies the last payment date made by the account.

Accounts/nickName

Specifies the account description.

Accounts/openingDate

Specifies the date on which the account was created.

Accounts/pendingDeposit

Specifies the funds that need to be credited to the account

Accounts/pendingWithdrawal

Specifies the funds that need to be debited from the account

Accounts/routingNumber

Specifies the sort code of the account.

Accounts/supportBillPay

This flag specifies whether a user can perform bill pay with this account.

Accounts/supportDeposit

This flag specifies whether the account supports deposit payments.

Accounts/supportTransferFrom

This flag specifies whether a user can debit and transfer the amount from their account.

Accounts/supportTransferTo

This flag specifies whether a user can credit amount to his account or not.

Accounts/swiftCode

Specifies the BIC code of the account.

Accounts/statusDesc

Specifies the arrangement status of the account.

Accounts/supportChecks

This flag specifies whether an account supports check payments with this accounts or not.

Accounts/Account_id

Specifies the account ID.

Accounts/AccountName

Specifies the name of the account that includes account product description.

ClosedView the Sample Response Code 
{
    "Accounts": [
        {
            "accountID": "87149",
            "accountHolder": "{\"fullname\":\"Benjamin\"}",
            "accountName": "Savings Account",
            "accountType": "Savings",
            "displayName": "Savings Account",
            "availableBalance": "100293",
            "bankName": "Model bank Company",
            "currencyCode": "USD",
            "currentBalance": "100293",
            "dividendLastPaidAmount": "0",
            "dividendPaidYTD": "0",
            "dividendRate": "0",
            "jointHolders": "[{\"fullname\":\"Benjamin\"},{\"fullname\":\"Rolf\"}]",
            "lastPaymentDate": "2019-04-17T00:00:00.0",
            "nickName": "New Savings Account",
            "openingDate": "2019-04-17 00:00:00.0",
            "pendingDeposit": "0",
            "pendingWithdrawal": "0",
            "routingNumber": "601613",
            "supportBillPay": "1",
            "supportDeposit": "1",
            "supportTransferFrom": "1",
            "supportTransferTo": "1",
            "swiftCode": "DEMOGBPX",
            "statusDesc": "AUTH",
            "supportChecks": "1",
            "Account_id": "87149",
            "AccountName": "Savings Account"
        }
    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s): Error Code: 20041
Error Message: "Message stating backend failed while retrieving accounts"
Associated Enterprise APIs:
  • getArrangements (Party Arrangement)
  • getAccountBalances (Holdings)
  • getLogoURL (AccountAggregation)
Closed GetAccountsDetails
 
Description: This API retrieves details of a particular account. This API in invoked from client when the user selects a particular account.
Method: POST
URL: /services/data/v1/RBObjects/operations/Accounts/getAccountDetails
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

accountID

Specifies the account ID of the user details that you want to fetch.

{
accountID : "87149",
}
Response:
ClosedView the Response Parameters

Accounts[ ]

Specifies the list of all the accounts and their respective details that are fetched after the user logs in.

Parameters

Accounts/accountID

Specifies the account identification number.

Accounts/accountHolder

Specifies the primary customer name.

Accounts/accountName

Specifies the name/description of the account

Accounts/accountPreference

Specifies the preference account for the user.

Accounts/accountType

Specifies the type of the account such as Savings, Checking, and so on.

Accounts/displayName

Specifies the product description of the account.

Accounts/availableBalance

Specifies the current available balance in the account.

Accounts/availableCredit

Specifies the credit that can be availed by the user.

Accounts/availablePoints

Specifies the number of points that the user can avail for various benefits.

Accounts/bankName

Specifies the branch name of the account.

Accounts/bondInterest

Specifies the amount of interest that a bond generates.

Accounts/bondInterestLastYear

Specifies the amount of interest that the same bond generated the previous year.

Accounts/bsbNum

Specifies the Bank-State-Branch number that is specific to Australia.

Accounts/bankName

Specifies the name of the bank.

Accounts/creditLimit

Specifies the upper limit up to which the user can avail the credit facilities.

Accounts/closingDate

Specifies the date of closing for the account.

Accounts/currencyCode

Specifies the code of the account currency.

Accounts/currentAmountDue

Specifies the amount that is currently in due by the customer.

Accounts/currentBalance

Specifies the actual online balance of the account.

Accounts/dividendLastPaidAmount

Specifies the amount of interest that you paid last time.

Accounts/dividendPaidYTD

Specifies the amount of dividend paid from the beginning of the year to the current date.

Accounts/dividendRate

Specifies the rate for dividend for the account.

Accounts/dividendYTD

Specifies the dividend amount paid by the user .

Accounts/dividendRate

Specifies the dividend rate.

Accounts/isPFM

Specifies whether the account supports Personal Finance Management feature.

Accounts/jointHolders

Specifies the name of the joint owner/secondary holder of the account.

Accounts/lastPaymentDate

Specifies the last payment date made by the account.

Accounts/dueDate

Specifies the due date for interest payment.

Accounts/nickName

Specifies the nick name of the account.

Accounts/openingDate

Specifies the date on which the account was created.

Accounts/pendingDeposit

Specifies the funds that need to be credited to the account

Accounts/pendingWithdrawal

Specifies the funds that need to be debited from the account

Accounts/routingNumber

Specifies the sort code of the account.

Accounts/supportBillPay

This flag specifies whether a user can perform bill pay with this account.

Accounts/supportDeposit

This flag specifies whether the account supports deposit payments.

Accounts/supportTransferFrom

This flag specifies whether a user can debit and transfer the amount from their account.

Accounts/supportTransferTo

This flag specifies whether a user can credit amount to his account or not.

Accounts/swiftCode

Specifies the BIC code of the account.

Accounts/statusDesc

Specifies the arrangement status of the account.

Accounts/supportChecks

This flag specifies whether an account supports check payments with this accounts or not.

Accounts/Account_id

Specifies the account id.

Accounts/AccountName

Specifies the name of the account that includes account product description.

Accounts/isBusinessAccount

Specifies whether the account is a business account. The value is Boolean.

Accounts/paidInstallmentsCount

Specifies the count of installments that were paid. The value is Boolean.

Accounts/overDueInstallmentsCount

Specifies the count of installments that are over due.

Accounts/futureInstallmentsCount

Specifies the count of installments that the user must pay in future.

ClosedView the Sample Response Code for Mock Services 
    {
   "Accounts":[
      {
         "accountID":"190128223246822",
         "accountHolder":"{\"username\": \"dbpolbuser\", \"fullname\": \"John\"}",
         "accountName":"Turbo Auto Loan",
         "accountPreference":"3",
         "accountType":"Loan",
         "displayName":"Loan",
         "availableBalance":"0",
         "availableCredit":"0.0",
         "availablePoints":"0",
         "bankName":"Infinity",
         "bondInterest":"0.00",
         "bondInterestLastYear":"0.00",
         "bsbNum":"123456789",
         "closingDate":"2019-08-08T12:00:00Z",
         "creditLimit":"0.00",
         "currencyCode":"USD",
         "currentAmountDue":"736",
         "currentBalance":"0.0",
         "dividendLastPaidAmount":"0.00",
         "dividendPaidYTD":"0.00",
         "dividendRate":"0.00",
         "dividendYTD":"0.00",
         "dueDate":"2018-08-12T12:00:00Z",
         "eStatementEnable":"false",
         "favouriteStatus":"0",
         "interestEarned":"0.00",
         "interestPaidLastYear":"289",
         "interestPaidPreviousYTD":"289",
         "interestPaidYTD":"242.30",
         "interestRate":"2.25",
         "isPFM":"false",
         "jointHolders":"[{\"username\": \"dbpolbuser\", \"fullname\": \"John\"},{\"username\": \"john.joe\", \"fullname\": \"John joe\"}]",
         "lastDividendPaidAmount":"0.00",
         "lastPaymentAmount":"368",
         "lastPaymentDate":"2019-01-23T10:32:41",
         "lastStatementBalance":"0.0",
         "lateFeesDue":"11",
         "maturityAmount":"0.00",
         "minimumDue":"0.0",
         "nickName":"Turbo Auto Loan",
         "openingDate":"2016-08-08T00:00:00",
         "originalAmount":"20000",
         "outstandingBalance":"16760.23",
         "paymentDue":"13",
         "payoffAmount":"16773.23",
         "payOffCharge":"749",
         "pendingDeposit":"0.00",
         "pendingWithdrawal":"0.00",
         "previousYearsDividends":"0.00",
         "principalBalance":"16024.23",
         "principalValue":"7120.0",
         "regularPaymentAmount":"0.00",
         "routingNumber":"648721691",
         "supportBillPay":"0",
         "supportCardlessCash":"0",
         "supportDeposit":"0",
         "supportTransferFrom":"0",
         "supportTransferTo":"1",
         "swiftCode":"CTBAUS124",
         "totalCreditMonths":"0",
         "totalDebitsMonth":"0",
         "unpaidInterest":"0.00",
         "statusDesc":"Active",
         "supportChecks":"0",
         "Account_id":"190128223246822",
         "AccountName":"Turbo Auto Loan",
         "isBusinessAccount":"false",
         "paidInstallmentsCount":"11",
         "overDueInstallmentsCount":"3",
         "futureInstallmentsCount":"4"
      }
   ],
   "opstatus":0,
   "httpStatusCode":0
}
ClosedView the Sample Response Code for Transact Services 
    {
   "Accounts":[
      {
         "paidInstallmentsCount":"0",
         "accountID":"81965",
         "accountHolder":"{\"username\":\"Harry CrispP12\",\"fullname\":\"Harry CrispP12\"}",
         "accountName":"Mortgage Loan",
         "accountType":"Loan",
         "availableBalance":"",
         "currencyCode":"USD",
         "currentAmountDue":"1607.43",
         "currentBalance":"-60654.11",
         "interestPaidYTD":"154.11",
         "interestRate":"5",
         "jointHolders":"",
         "lastPaymentAmount":"",
         "lastPaymentDate":"",
         "maturityDate":"2023-03-19",
         "nickName":"Mortgage Loan",
         "openingDate":"2020-03-19",
         "originalAmount":"75000",
         "outstandingBalance":"74046.68",
         "paymentDue":"75000",
         "payoffAmount":"75000",
         "principalBalance":"75000",
         "principalValue":"75000",
         "AccountName":"Mortgage Loan",
         "nextPaymentAmount":"1107.43",
         "nextPaymentDate":"2020-04-18",
         "arrangementId":"AA2007900C5W",
         "productId":"MORTGAGE",
         "isBusinessAccount":"false",
         "overDueInstallmentsCount":"2",
         "futureInstallmentsCount":"72"
      }
   ],
   "opstatus":0,
   "httpStatusCode":200
}
ClosedView the Sample Response Code for Microservices 
    {
   "Accounts":[
      {
         "accountID":"GB0010001-97799",
         "accountHolder":"{\"username\":\"Rolf Gerlingg\",\"fullname\":\"Rolf Gerlingg\"}",
         "accountName":"Mortgage",
         "accountType":"Loan",
         "displayName":"Mortgage",
         "availableBalance":"-296500",
         "bankName":"Model Bank",
         "currencyCode":"USD",
         "currentBalance":"-296500",
         "dividendLastPaidAmount":"0",
         "dividendPaidYTD":"0",
         "dividendRate":"0",
         "jointHolders":"[]",
         "nickName":"Mortgage Loan",
         "openingDate":"2020-04-17 00:00:00.0",
         "outstandingBalance":"0",
         "pendingDeposit":"0",
         "pendingWithdrawal":"0",
         "supportBillPay":"1",
         "supportDeposit":"1",
         "supportTransferFrom":"1",
         "supportTransferTo":"1",
         "statusDesc":"CURRENT",
         "supportChecks":"1",
         "Account_id":"GB0010001-97799",
         "AccountName":"Mortgage",
         "processingTime":"2020-10-07T08:29:33",
         "externalIndicator":"false",
         "paidInstallmentsCount":"3",
         "overDueInstallmentsCount":"1",
         "futureInstallmentsCount":"385"
      }
   ],
   "opstatus":0,
   "httpStatusCode":0
}
Error Code(s): Error Code: 20041
Error Message: "Message stating backend failed while retrieving account"
Associated Services:
Integration Services
  • dbpNonProductServices: getAccountDetails (Mock services)
  • T24ISExtra: getAccountDetails (Transact)

  • ArrangementsMicroServicesJava: getAccountDetails (Microservice)

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?