Personal Financial Management (PFM) Account

This API allows the user to fetch all the Personal Financial Management accounts.

customVerb - getPFMAccounts

/services/data/v1/RBObjects/operations/PFMAccounts/getPFMAccounts

Authorized App User

X-Kony-Authorization

Parameters

year

Specifies the year for which PFM Accounts are to be fetched

monthId

Specifies the id of the required month

{
 "year":2020,
 "monthId":6
}

Parameters

/records

Specifies an array of records that contains various details.

supportBillPay

Specifies whether the PFM Account supports the Bill Pay feature. The value is Boolean.

bankName

Specifies the name of the bank.

availablePoints

Specifies the available points that the customer can cash and use for later transactions.

supportDeposit

Specifies the amount that is present in the form of a deposit.

availableBalance

Specifies the account balance of the customer.

isPFM

Specifies whether the account is a PFM account or not.

accountID

Specifies the unique ID of the account.

principalValue

Specifies the principal value of the account.

supportTransferTo

openingDate

Specifies the date and time on which the bank account was opened.

outstandingBalance

Specifies the outstanding amount that has been used by the customer over the available balance.

interestRate

Specifies the amount of interest rate.

nickName

Specifies the nickname of the customer.

currentBalance

Specifies the current available balance in the PFM account of the customer.

accountType

Specifies the type of account (Savings, Deposit, Checking, Loan, and so on)

minimumDue

Specifies the minimum due amount that the customer is yet to pay.

lastStatementBalance

Specifies the balance statement of the customer after the last transaction.

supportTransferFrom

Specifies the number of accounts from which the transfer occurs.

currrencyCode

Specifies the currency code of the PFM Account.

totalCreditMonths

Specifies the total number of credit months.

totalDebitMonths

Specfies the total number of debit months.

{
  "records": [
    {
      "supportBillPay": "1",
      "accountName": "Rewards Savings",
      "bankName": "Infinity",
      "availablePoints": "0",
      "supportDeposit": "1",
      "availableBalance": "6700.89",
      "isPFM": "true",
      "accountID": "190128223241502",
      "principalValue": "0.0",
      "supportTransferTo": "1",
      "openingDate": "2016-10-10T00:00:00",
      "outstandingBalance": "0.0",
      "interestRate": "0.0",
      "nickName": "My Savings",
      "currentBalance": "5296.78",
      "accountType": "Savings",
      "minimumDue": "0.0",
      "lastStatementBalance": "0.0",
      "supportTransferFrom": "1",
      "currencyCode": "USD",
      "totalCreditMonths": "370",
      "totalDebitsMonth": "734"
    }  ]