Arrangement

• X-Kony-Authorization

• X-Kony-ReportingParams

Parameters

accountID

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

{
    "accountID": "125978"
}

Accounts[ ]

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

Parameters

accountID

Specifies the account identification number.

accountHolder

Specifies the primary customer name.

accountName

Specifies the name/description of the account

accountPreference

Specifies the preference account for the user.

accountType

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

displayName

Specifies the product description of the account.

availableBalance

Specifies the current available balance in the account.

availableCredit

Specifies the credit that can be availed by the user.

availablePoints

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

bankName

Specifies the branch name of the account.

bondInterest

Specifies the amount of interest that a bond generates.

bondInterestLastYear

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

bsbNum

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

bankName

Specifies the name of the bank.

creditLimit

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

closingDate

Specifies the date of closing for the account.

currencyCode

Specifies the code of the account currency.

currentAmountDue

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

currentBalance

Specifies the actual online balance of the account.

dividendLastPaidAmount

Specifies the amount of interest that you paid last time.

dividendPaidYTD

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

dividendRate

Specifies the rate for dividend for the account.

dividendYTD

Specifies the dividend amount paid by the user .

dividendRate

Specifies the dividend rate.

isPFM

Specifies whether the account supports Personal Finance Management feature.

jointHolders

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

lastPaymentDate

Specifies the last payment date made by the account.

dueDate

Specifies the due date for interest payment.

nickName

Specifies the nick name of the account.

openingDate

Specifies the date on which the account was created.

pendingDeposit

Specifies the funds that need to be credited to the account

pendingWithdrawal

Specifies the funds that need to be debited from the account

routingNumber

Specifies the sort code of the account.

supportBillPay

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

supportDeposit

This flag specifies whether the account supports deposit payments.

supportTransferFrom

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

supportTransferTo

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

swiftCode

Specifies the BIC code of the account.

statusDesc

Specifies the arrangement status of the account.

supportChecks

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

Account_id

Specifies the account id.

AccountName

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

isBusinessAccount

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

paidInstallmentsCount

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

overDueInstallmentsCount

Specifies the count of installments that are over due.

futureInstallmentsCount

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

Response for Checking Account

    {
   "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
}

Response for Savings Account

{
    "Accounts": [{
        "accountID": "125512",
        "accountHolder": "{"
        username ":"
        SURENDRA1 ","
        fullname ":"
        SURENDRA1 "}",
        "accountName": "Savings Account",
        "arrangementId": "AA21105NCM72",
        "accountType": "Savings",
        "displayName": "Savings Account",
        "availableBalance": "0",
        "bankName": "Model Bank",
        "currencyCode": "USD",
        "currentBalance": "0",
        "companyId": "GB0010001",
        "dividendLastPaidAmount": "0",
        "dividendPaidYTD": "0",
        "dividendRate": "0",
        "interestRate": "2.0",
        "jointHolders": "[]",
        "lastPaymentDate": "",
        "nickName": "",
        "openingDate": "2021-04-05",
        "originalAmount": "0",
        "pendingDeposit": "0",
        "pendingWithdrawal": "0",
        "supportBillPay": "1",
        "supportDeposit": "1",
        "supportTransferFrom": "1",
        "supportTransferTo": "1",
        "statusDesc": "AUTH",
        "supportChecks": "1",
        "IBAN": "GB74DEMO60161300125512",
        "Account_id": "125512",
        "AccountName": "Savings Account",
        "externalIndicator": "false",
        "productId": "SAVINGS.ACCOUNT",
        "accruedInterest": "0.0"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

Response for Deposit Account

{
    "Accounts": [{
        "accountID": "50006905",
        "accountHolder": "{"
        username ":"
        William Bennett ","
        fullname ":"
        William Bennett "}",
        "accountName": "Long Term Deposit",
        "arrangementId": "AA211020ZMKL",
        "accountType": "Deposit",
        "displayName": "Long Term Deposit",
        "availableBalance": "1250000",
        "bankName": "BSG Company",
        "currencyCode": "EUR",
        "currentBalance": "1250000",
        "companyId": "NL0020001",
        "dividendLastPaidAmount": "0",
        "dividendPaidYTD": "0",
        "dividendRate": "0",
        "interestRate": "0.85",
        "jointHolders": "[]",
        "lastPaymentDate": "",
        "openingDate": "2021-04-12",
        "originalAmount": "1250000",
        "outstandingBalance": "0.0",
        "pendingDeposit": "0",
        "pendingWithdrawal": "0",
        "principalValue": "0.0",
        "supportBillPay": "1",
        "supportDeposit": "1",
        "supportTransferFrom": "1",
        "supportTransferTo": "1",
        "statusDesc": "CURRENT",
        "supportChecks": "1",
        "IBAN": "",
        "Account_id": "50006905",
        "AccountName": "Long Term Deposit",
        "processingTime": "2021-08-11T07:18:18",
        "externalIndicator": "false",
        "productId": "DEPOSIT.LONG",
        "accruedInterest": "88.54",
        "termInterestDue": "-4860.94",
        "interestDueDate": "2021-10-12"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 20041
  Error Message: "Backend failed to fetch account details."
• Error Code: 20048
  Error Message: "Please Provide Account ID."
• Error Code: 20055
  Error Message: "Couldn't generate Auth Token Successfully, empty response."
• Error Code: 20056
  Error Message: "Unable to get micro service account id."
• Error Code: 20047
  Error Message: "Invalid Customer Type."
• Error Code: 20049
  Error Message: "Backend failed to fetch arrangement details from Arrangement Micro Services."

X-Kony-Authorization

X-Kony-ReportingParams

Parameters

userName

Specifies the username.

account_id

Specifies the unique ID of the account

userId (Mandatory)

Specifies the Retail Banking user ID.

{
   "userName":"dbpolbuser",
   "account_id":"",
   "userId":""
}

X-Kony-Authorization

X-Kony-ReportingParams

Parameters

Customer_id (Mandatory)

Specifies the unique ID of the customer based on which the accounts get fetched.

account_id

Specifies the unique ID of the account

userId

Specifies the Retail Banking user ID.

{
   "Customer_id" : "1002191128"
   "account_id":"",
   "userId":""
}

• X-Kony-Authorization

• X-Kony-Reporting Params

Parameters

name (Mandatory)

Specifies the account name.

accountIds (Mandatory)

Specifies the ID of account.

{
    "name": "abcd",
    "accountIds": "117722"
}

{
    "id": "14",
    "accountIds": "117722",
    "name": "abcd",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 12002
  Error Message: "Invalid account number. please provide valid details."
• Error Code: 12513
  Error Message: " Failed to create custom view."

• X-Kony-Authorization

• X-Kony-Reporting Params

{}

View the Response Parameters

id(Mandatory)

Specifies the ID.

accountIds(Mandatory)

Specifies the ID of accounts.

name(Mandatory)

Specifies the name of account.

{
    "customview": [{
        "id": "12",
        "accountIds": "117738",
        "name": "Loan7738"
    }, {
        "id": "13",
        "accountIds": "117722",
        "name": "abc"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 12515
  Error Message: " Failed to get custom view."

• X-Kony-Authorization

• X-Kony-Reporting Params

Parameters

id(Mandatory)

Specifies the ID.

accountIds(Mandatory)

Specifies the ID of accounts.

name(Mandatory)

{
    "id": "13",
    "name": "abc",
    "accountIds": "117722,117738"
}

{
    "id": "13",
    "accountIds": "117722,117738",
    "name": "abc",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 12516
  Error Message: " Failed to edit custom view."

X-Kony-Authorization

X-Kony-Reporting Params

Parameters

id (Mandatory)

Specifies the unique ID.

{
    "id": "13"
}

{
    "id": "14",
    "opstatus": 0,
    "httpStatusCode": 0
}

• Error Code: 12000
  Error Message: "Internal service error."
• Error Code: 12001
  Error Message: "Logged in User is not authorized to perform this action."
• Error Code: 12515
  Error Message: " Failed to get custom view."
• Error Code: 12514
  Error Message: " Failed to delete custom view."

X-Kony-Authorization

X-Kony-Reporting Params

{
    "userName": "0211355575",
    "deviceID": "08fNDL-JOM0185-jhf180"
}

Parameters

id (Mandatory)

Specifies the Unique identification number.

accountIds (Mandatory)

Specifies the unique account ID.

name (Mandatory)

{
"Accounts": [
{
"accountHolder": "{"username":"","fullname":""}",
"accountID": "117722",
"Account_id": "117722",
"arrangementId": "AA21105SMGGJ",
"accountName": "Personal Loan",
"accountType": "Loan",
"bankName": "Model Bank",
"currencyCode": "USD",
"transactionCurrency": "USD",
"currentAmountDue": "10000",
"currentBalance": "-10000",
"nickName": "Personal Loan",
"openingDate": "2021-04-15",
"originalAmount": "0",
"paymentDue": "10000",
"productId": "PERSONAL.LOAN",
"displayName": "Loan",
"supportBillPay": "1",
"supportChecks": "1",
"supportDeposit": "1",
"supportTransferFrom": "1",
"supportTransferTo": "1",
"outstandingBalance": "10000",
"principalValue": "0",
"payoffAmount": "10000",
"principalBalance": "10000",
"isPortFolioAccount": "false",
"categoryId": "3102",
"eStatementEnable": "false",
"accountIBAN": "NA",
"isNew": "false",
"productGroup": "Loan",
"account_id": "117722",
"actions": "["INTRA_BANK_FUND_TRANSFER_CANCEL_APPROVE","DOMESTIC_WIRE_TRANSFER_APPROVE","INTER_BANK_ACCOUNT_FUND_TRANSFER_APPROVE","INTRA_BANK_FUND_TRANSFER_SELF_APPROVAL","ACH_COLLECTION_EDIT_TEMPLATE","ACH_FILE_SELF_APPROVAL","INTER_BANK_ACCOUNT_FUND_TRANSFER_SELF_APPROVAL","INTERNATIONAL_WIRE_TRANSFER_APPROVE","TRANSFER_BETWEEN_OWN_ACCOUNT_VIEW_RECEPIENT","WITHDRAW_CASH_CARDLESS_CASH","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_VIEW_RECEPIENT","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE","ACH_COLLECTION_VIEW","VIEW_CHEQUES_VIEW","CHEQUE_BOOK_REQUEST_VIEW","ACH_PAYMENT_VIEW","INTRA_BANK_FUND_TRANSFER_VIEW","BULK_PAYMENT_REQUEST_SUBMIT","BULK_PAYMENT_FILES_MULTI_UPLOAD_CSV","INTERNATIONAL_WIRE_TRANSFER_CREATE_RECEPIENT","BILL_PAY_BULK","ACH_FILE_APPROVE","INTRA_BANK_FUND_TRANSFER_CREATE_RECEPIENT","DOMESTIC_WIRE_TRANSFER_CREATE","BULK_PAYMENT_FILES_SINGLE_UPLOAD_CSV","INTER_BANK_ACCOUNT_FUND_TRANSFER_CANCEL","ACH_PAYMENT_DELETE_TEMPLATE","INTER_BANK_ACCOUNT_FUND_TRANSFER_CANCEL_APPROVE","INTERNATIONAL_WIRE_TRANSFER_UPDATE_BULK_TEMPLATES","TRANSFER_BETWEEN_OWN_ACCOUNT_SELF_APPROVAL","CHEQUE_BOOK_REQUEST_CREATE","INTERNATIONAL_WIRE_TRANSFER_DELETE_RECEPIENT","ACH_COLLECTION_SELF_APPROVAL","ACH_COLLECTION_DELETE_TEMPLATE","REVOKE_STOP_PAYMENT_REQUEST_CREATE","RDC","ACH_FILE_VIEW","BULK_PAYMENT_REQUEST_VIEW","BILL_PAY_DELETE_PAYEES","TRANSFER_BETWEEN_OWN_ACCOUNT_CANCEL","BULK_PAYMENT_FILES_MULTI_UPLOAD_XML","DOMESTIC_WIRE_TRANSFER_VIEW","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_SELF_APPROVAL","BULK_PAYMENT_TEMPLATE_EDIT","TRANSFER_BETWEEN_OWN_ACCOUNT_APPROVE","INTERNATIONAL_WIRE_TRANSFER_VIEW","BILL_PAY_VIEW_PAYEES","INTRA_BANK_FUND_TRANSFER_APPROVE","SKIP_NEXT_PAYMENT","TRANSFER_BETWEEN_OWN_ACCOUNT_DELETE_RECEPIENT","ACH_PAYMENT_CREATE","WITHDRAW_CASH_VIEW_SUMMARY","DISPUTE_TRANSACTIONS","BULK_PAYMENT_FILES_SINGLE_UPLOAD_XML","ACH_COLLECTION_CREATE_TEMPLATE","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CANCEL","CHECK_MANAGEMENT","ACH_COLLECTION_CREATE","STOP_PAYMENT_REQUEST_VIEW","STOP_PAYMENT_REQUEST_CREATE","BILL_PAY_VIEW_PAYMENTS","INTERNATIONAL_WIRE_TRANSFER_VIEW_BULK_TEMPLATES","CHECK_MANAGEMENT_VIEW_DISPUTED_CHECKS","DOMESTIC_WIRE_TRANSFER_VIEW_RECEPIENT","INTERNATIONAL_WIRE_TRANSFER_SELF_APPROVAL","DIRECT_DEBIT_CREATE","INTER_BANK_ACCOUNT_FUND_TRANSFER_DELETE_RECEPIENT","BILL_PAY_CREATE","INTRA_BANK_FUND_TRANSFER_VIEW_RECEPIENT","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_DELETE_RECEPIENT","DOMESTIC_WIRE_TRANSFER_SELF_APPROVAL","DISPUTE_TRANSACTIONS_MANAGE","INTRA_BANK_FUND_TRANSFER_DELETE_RECEPIENT","INTER_BANK_ACCOUNT_FUND_TRANSFER_VIEW","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_APPROVE","DOMESTIC_WIRE_TRANSFER_CREATE_RECEPIENT","BILL_PAY_SELF_APPROVAL","INTERNATIONAL_WIRE_TRANSFER_CREATE","VIEW_INSTALLMENT_SUMMARY","INTER_BANK_ACCOUNT_FUND_TRANSFER_VIEW_RECEPIENT","BULK_PAYMENT_TEMPLATE_VIEW","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CANCEL_APPROVE","TRANSFER_BETWEEN_OWN_ACCOUNT_CANCEL_APPROVE","INTRA_BANK_FUND_TRANSFER_CANCEL","ACH_FILE_UPLOAD","BULK_PAYMENT_REQUEST_EDIT","INTERNATIONAL_WIRE_TRANSFER_VIEW_RECEPIENT","DOMESTIC_WIRE_TRANSFER_DELETE_RECEPIENT","BULK_PAYMENT_TEMPLATE_DOWNLOAD","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE_RECEPIENT","INTRA_BANK_FUND_TRANSFER_CREATE","BULK_PAYMENT_REQUEST_APPROVE","VIEW_LOAN_SCHEDULE","DIRECT_DEBIT_VIEW","TRANSFER_BETWEEN_OWN_ACCOUNT_VIEW","BULK_PAYMENT_FILES_VIEW","INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE_RECEPIENT","TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE_RECEPIENT","TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE","CHECK_MANAGEMENT_ADD_STOP_CHECK_REQUEST","INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE","BILL_PAY_APPROVE","BULK_PAYMENT_TEMPLATE_DELETE","DIRECT_DEBIT_CANCEL","BULK_PAYMENT_TEMPLATE_MULTIPLE_CREATE","BULK_PAYMENT_TEMPLATE_SINGLE_CREATE","ACH_COLLECTION_APPROVE","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_VIEW","DISPUTE_TRANSACTIONS_VIEW","BILL_PAY_CREATE_PAYEES"]",
"Membership_id": "800199",
"coreCustomerId": "800199",
"MembershipName": "Rolf Gerling1",
"coreCustomerName": "Rolf Gerling1",
"isBusinessAccount": "true",
"favouriteStatus": "0"
}
],
"opstatus": 0,
"httpStatusCode": 200
}

• Error Code: 20041
  Error Message: "Message stating backend failed while retrieving accounts."
• Error Code: 20055
  Error Message: "Couldn't generate Auth Token Successfully, empty response."
• Error Code: 20049
  Error Message: "Backend failed to fetch arrangement details from Arrangement Micro Services."
• Error Code: 10406
  Error Message: "Backend failed to update status."
• Error Code: 10770
  Error Message: "Failed to fetch the relative customers."
• Error Code: 10765
  Error Message: "Failed to fetch core contract customers."