4. Account details Section
Get Account Details API
Description: to get the account details to populate account details page in both web and mobile
apps
API: /RBObjects/operations/Accounts/getAccountDetails
Mandatory property marker → Mandatory
Request payload:
{
"accountID": ""
}
Expected response sample:
note: some of the response properties are populated depending on the account type. Any
custom details that the bank wants to show on the details screen are not included here
{
"Accounts": [
{
"accountID": "210506142216925",
"accountHolder": "{"username": "chathura7", "fullname": "John"}",
"accountName": "12 Months Term Deposit",
"accountPreference": "4",
"accountType": "Deposit",
"displayName": "Deposit",
"availableBalance": "0",
"availableCredit": "0.0",
"availablePoints": "0",
"bankName": "Infinity",
"bondInterest": "0.00",
"bondInterestLastYear": "0.00",
"bsbNum": "123456789",
"creditLimit": "0.00",
"currencyCode": "USD",
"currentAmountDue": "0.00",
"currentBalance": "5018.0",
"dividendLastPaidAmount": "6.95",
"dividendLastPaidDate": "2021-05-02T14:22:16",
"dividendPaidYTD": "18",
"dividendRate": "1.25",
"dividendYTD": "18",
"eStatementEnable": "false",
"favouriteStatus": "0",
"interestEarned": "18",
"interestPaidLastYear": "0.00",
"interestPaidPreviousYTD": "0.00",
"interestPaidYTD": "0.00",
6. Retrieve account transactions API
Description: API to load the transactions done on a particular account depending on transaction
type. This API should be Search, sort, filter and pagination enabled
API: RBObjects/operations/Transactions/getAccountTransactionByType
Transaction type -> all
Request payload:
{
"accountID": "190128223242830",
"transactionType": "All",
"offset": 0,
"limit": 300,
"isScheduled": false,
"order": "desc"
}
Search query params
URL: /RBObjects/objects/Transactions?
searchTransactionType=Deposit
searchDescription=sdfsdf
searchMinAmount=100
searchMaxAmount=1000
searchStartDate=2021-04-30
searchEndDate=2021-05-14
fromCheckNumber=234
toCheckNumber=345
accountNumber=190128223242830
isScheduled=0
searchType=Search
Expected Response sample:
{
"Transactions": [
{
"isScheduled": "false",
"checkNumber": "0",
"payeeCurrency": "INR",
7. "numberOfRecurrences": "0",
"amountRecieved": "0",
"transactionId": "12089",
"toAccountName": "Rewards Savings",
"payPersonName": "",
"fromAccountNumber": "190128223242830",
"checkNumber2": "Check #",
"fromNickName": "My Checking",
"checkNumber1": "Check #",
"cashAmount": "0.00",
"description": "Online transfer from Core Checking Masked Account Number",
"transactionType": "InternalTransfer",
"fromAccountType": "Checking",
"isDisputed": "false",
"isPayeeDeleted": "false",
"amount": "-1600.00",
"toAccountType": "Savings",
"fromAccountName": "Core Checking",
"hasDepositImage": "false",
"transactionDate": "2021-05-04T08:28:21Z",
"postedDate": "2021-05-04T08:28:21Z",
"totalCheckAmount": "0.00",
"statusDescription": "Pending",
"fromAccountBalance": "6949.78",
"transactionsNotes": "Saving for a car",
"toAccountNumber": "190128223241502",
"withdrawlAmount2": "0.00",
"frequencyType": "Once",
"withdrawlAmount1": "0.00",
"category": "Uncategorised",
"fee": "0.00"
}
],
"Meta": [
{
"pageSize": "300",
"pageStart": "0",
"totalSize": "58"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
Login Section
Quick Balance API
Description: API to load the quick balance of the user accounts (mobile only)
8. Statements Section
eStatements API
Description: API to get the estatements
Flow is not working in the dev environment
Combined eStatement API
Description: API to get the combined eStatement
Flow is not working in the dev environment
Beneficiary management
External Recipient
Create External Payee API (Create external account beneficiary)
Description: API to create an external account as a beneficiary.
API: /PayeeObjects/operations/Recipients/createExternalPayee
Request payload:
{
"routingNumber": "123123",
"swiftCode": "",
"bankName": "Infinity",
"accountType": "",
"accountNumber": "123123123",
"beneficiaryName": "chathura account",
"nickName": "chathura account",
"isBusinessPayee": "0",
"displayName": "OTHER_EXTERNAL_ACCOUNT",
"isSameBankAccount": "false",
"isInternationalAccount": "false",
"isVerified": "true",
"": "true",
"cif": "[{"contractId":"7321457251","coreCustomerId":"1425958,1578660"}]"
}
9. Expected response sample:
{
"Id": "51403774",
"opstatus": 0,
"httpStatusCode": 0
}
Get External Payees API
Description: API to list down the accounts in the Manage recipient screen
API: /PayeeObjects/operations/Recipients/getExternalPayees
Request payload:
{
“userId”: “USER_ID”
"offset": 0,
"limit": 2000,
"resetSorting": true,
"dataSource": "fabric"
}
Expected response sample:
{
"ExternalAccounts": [
{
"accountNumber": "123123123",
"bankName": "Infinity",
"beneficiaryName": "chathura account",
"createdOn": "2021-05-28",
"isInternationalAccount": "false",
"isSameBankAccount": "false",
"isVerified": "true",
"nickName": "chathura account",
"routingNumber": "123123",
"cif": "[{"coreCustomerId":"1425958,1578660","contractId":"7321457251"}]",
"Id": "51403774",
"noOfCustomersLinked": "2"
}
],
10. "opstatus": 0,
"httpStatusCode": 0
}
Edit External Payees API
Description: API to update a saved external payee
API: /PayeeObjects/operations/Recipients/editExternalPayee
Request payload:
{
"routingNumber": "123123",
"swiftCode": "N/A",
"bankName": "Infinity",
"accountType": "",
"accountNumber": "123123123",
"oldName": "",
"beneficiaryName": "chathura account new",
"nickName": "chathura account new",
"isBusinessPayee": "",
"displayName": "",
"isSameBankAccount": "false",
"isInternationalAccount": "false",
"payeeId": "51403774",
"": "51403774",
"cif": "[{"contractId":"7321457251","coreCustomerId":"1425958,1578660"}]"
}
Expected response sample:
{
"Id": "51403774",
"opstatus": 0,
"httpStatusCode": 0
}
Get External Payee transactions
Description: API to get a list of transactions made for an external account
API: /RBObjects/operations/Transactions/getToExternalAccountTransactions
11. Request payload:
{
"beneficiaryId": "41624700",
"accountNumber": "123123234",
"firstRecordNumber": 0,
"lastRecordNumber": 10
}
Expected response sample:
No data in the dev environment
Delete External recipient API
Description: API to delete a saved external payee
API: /PayeeObjects/operations/Recipients/deleteExternalPayee
Request payload:
{
"accountNumber": "123123123",
"Id": "51403774",
"isSameBankAccount": "false",
"isInternationalAccount": "false"
}
Expected response sample:
{
"Id": "51403774",
"opstatus": 0,
"httpStatusCode": 0,
"deletedRecords": "1"
}
Internal Recipient
Add internal recipient
Description: API to create an internal account (same bank) as a beneficiary.
16. "httpStatusCode": 0
}
Get P2P recipient List
Description: API to get a saved p2p recipient list
API: /PayeeObjects/operations/Recipients/getP2PPayee
Request payload:
{
"offset": 0,
"limit": 2000,
"resetSorting": true,
"sortBy": "nickName",
"order": "asc",
"dataSource": "fabric"
}
Expected response sample:
{
"PayPerson": [
{
"email": "chathura.s@tailwindsw.com",
"name": "new lmts",
"nickName": "new lmts",
"PayPersonId": "74630126",
"primaryContactForSending": "chathura.s@tailwindsw.com",
"cif": "[{"coreCustomerId":"1425958,1578660","contractId":"7321457251"}]",
"noOfCustomersLinked": "2"
}
],
"opstatus": 0,
"httpStatusCode": 0
}
View activity for P2P recipient
Description: API to get the transfer history for a selected p2p recipient
API: /RBObjects/operations/Transactions/getPayPersonHistory
Request payload:
{
"personId": "74630126",
"offset": 0,
17. "limit": 10
}
Expected response sample:
No data in the dev environment
Transfer Section
Internal - Same user transfer
Description: API to transfer to the same logged in user accounts for same day and future dates
API: /TransactionObjects/operations/Transaction/TransferToOwnAccounts
Important Notes:
1. same date transactions will have isScheduled = 0 and future date transactions will
have isScheduled = 1
2. FrequencyType will determine whether its a standing order or a single transfer
(frequencyType": "Once" for single transfers)
3. numberOfRecurrences and frequencyEndDate will determine how the standing order
will end
Request payload:
{
"amount": "12.00",
"beneficiaryId": null,
"frequencyEndDate": "2021-06-11T09:12:07.579Z",
"frequencyType": "Once",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-11T09:12:07.579Z",
"toAccountNumber": "210607123921025",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": "USD",
"numberOfRecurrences": null,
"ExternalAccountNumber": null,
18. "routingNumber": "648721615"
}
Expected response sample:
{
"referenceId": "331342",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "12",
"frequencyEndDate": "2021-06-11T09:12:07Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-11T09:12:07Z",
"toAccountCurrency": "USD",
"toAccountNumber": "210607123921025",
"transactionCurrency": "USD",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"transactionAmount": "12.00"
}
External - Same Bank transfer
Description: API to transfer to the same logged in user accounts for same day and future dates
API: /TransactionObjects/operations/Transaction/IntraBankAccFundTransfer
Important Notes:
4. same date transactions will have isScheduled = 0 and future date transactions will
have isScheduled = 1
5. FrequencyType will determine whether its a standing order or a single transfer
(frequencyType": "Once" for single transfers)
6. numberOfRecurrences and frequencyEndDate will determine how the standing order
will end
Request payload:
{
20. External - Different Bank transfer
Description: API to transfer to different bank accounts for same day and future dates
API: /TransactionObjects/operations/Transaction/InterBankAccFundTransfer
Important Notes:
7. same date transactions will have isScheduled = 0 and future date transactions will
have isScheduled = 1
8. FrequencyType will determine whether its a standing order or a single transfer
(frequencyType": "Once" for single transfers)
9. numberOfRecurrences and frequencyEndDate will determine how the standing order
will end
Request payload:
{
"amount": "12.00",
"beneficiaryId": "11335",
"frequencyEndDate": "2021-06-12T14:01:06.284Z",
"frequencyType": "Once",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-12T14:01:06.284Z",
"toAccountNumber": "5528789466",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": null,
"numberOfRecurrences": null,
"ExternalAccountNumber": "5528789466",
"routingNumber": "765678987"
}
Expected response sample:
{
"referenceId": "331982",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "12",
"frequencyEndDate": "2021-06-12T14:01:06Z",
21. "frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-12T14:01:06Z",
"toAccountNumber": "5528789466",
"transactionCurrency": "USD",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"transactionAmount": "12.00"
}
P2P transfer (LMTS)
Description: API to transfer to a person
API: /TransactionObjects/operations/Transaction/P2PTransfer
Request payload:
{
"amount": "12.00",
"beneficiaryId": null,
"frequencyEndDate": "2021-06-12T14:07:40.101Z",
"frequencyType": "Once",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-12T14:07:40.101Z",
"transactionsNotes": "",
"transactionType": "P2P",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": null,
"numberOfRecurrences": null,
"ExternalAccountNumber": null,
"personId": "9083"
}
Expected response sample:
Flow is currently broken because of OTP
22. International account transfer
Description: API to transfer to an international account
API: /TransactionObjects/operations/Transaction/InternationalAccFundTransfer
Request payload:
{
"amount": "12.00",
"beneficiaryId": "11892",
"frequencyEndDate": "2021-06-12T14:16:26.297Z",
"frequencyType": "Once",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-12T14:16:26.297Z",
"toAccountNumber": "123123123",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": null,
"numberOfRecurrences": null,
"ExternalAccountNumber": "123123123"
}
Expected response sample:
{
"referenceId": "331984",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "12",
"frequencyEndDate": "2021-06-12T14:16:26Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "210607123920777",
"isScheduled": "0",
"scheduledDate": "2021-06-12T14:16:26Z",
"toAccountNumber": "123123123",
"transactionCurrency": "USD",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
38. Save operation
Description: API to get editable information
API: /PayeeObjects/operations/Recipients/editBillPayPayee
Request payload:
{
"payeeId": "29259472",
"payeeNickName": "AT and T",
"addressLine1": "",
"addressLine2": "Near Mylan Hotel",
"state": "Georgia",
"zipCode": "123123",
"cityName": "Atlanta",
"phone": "11231231231",
"cif": "[]"
}
Expected response sample:
{
"dbpErrCode": "12001",
"dbpErrMsg": "Logged in User is not authorized to perform this action",
"opstatus": 0,
"httpStatusCode": 0
}
Deactivate
Description: API to deactivate bill
API: /PayeeObjects/operations/Recipients/editBillPayPayee
Request payload:
{
"payeeId": "29259472",
"EBillEnable": 0
}
Expected response sample:
{
"payeeId": "29259472",
"opstatus": 0,
"httpStatusCode": 0
}
39. Delete Biller
Description: API to delete bill payee
API: /PayeeObjects/operations/Recipients/deleteBillPayPayee
Request payload:
{
"payeeId": "24044408"
}
Expected response sample:
{
"payeeId": "24044408",
"opstatus": 0,
"httpStatusCode": 0
}
Activate ebill
Description: API to activate a bill
API: /PayeeObjects/operations/Recipients/editBillPayPayee
Request payload:
{
"payeeId": "29259472",
"EBillEnable": 1
}
Expected response sample:
{
"payeeId": "29259472",
"opstatus": 0,
"httpStatusCode": 0
}
View Activity
Description: API to view payee bills
API: /RBObjects/operations/Transactions/getPayeeBills
Request payload:
{
"payeeId": "29259472",
"payeeName": "AT and T",
"payeeAccountNumber": "123123123",
40. "limit": "12"
}
Expected response sample:
{
"Transactions": [],
"opstatus": 0,
"httpStatusCode": 0
}
Pay bill (POST)
The flow is not working on the dev environment
Bulk bill pay (POST)
The flow is not working on the dev environment
!["interestEarned": "0.00",
"interestPaidLastYear": "0.00",
"interestPaidPreviousYTD": "0.00",
"interestPaidYTD": "0.00",
"interestRate": "0.0",
"isPFM": "true",
"jointHolders": "[{"username": "john.Doe", "fullname": "John Doe"}]",
"lastDividendPaidAmount": "0",
"lastPaymentAmount": "0.00",
"lastPaymentDate": "2021-05-05T14:22:16",
"lastStatementBalance": "0.0",
"lateFeesDue": "0.00",
"maturityAmount": "0.00",
"minimumDue": "0.0",
"nickName": "My Savings",
"openingDate": "2016-10-10T00:00:00",
"originalAmount": "0.00",
"outstandingBalance": "0.0",
"paymentDue": "0.00",
"payoffAmount": "0.00",
"payOffCharge": "0.00",
"pendingDeposit": "53",
"pendingWithdrawal": "500",
"previousYearsDividends": "0",
"principalBalance": "0.00",
"principalValue": "0.0",
"regularPaymentAmount": "0.00",
"routingNumber": "648721691",
"supportBillPay": "1",
"supportCardlessCash": "1",
"supportDeposit": "1",
"supportTransferFrom": "1",
"supportTransferTo": "1",
"swiftCode": "CTBAUS124",
"totalCreditMonths": "370",
"totalDebitsMonth": "734",
"unpaidInterest": "0.00",
"statusDesc": "Active",
"supportChecks": "1",
"Membership_id": "1339905",
"coreCustomerId": "1339905",
"Account_id": "210506142216163",
"AccountName": "Rewards Savings",
"isBusinessAccount": "true",
"MembershipName": "chathura7",
"coreCustomerName": "chathura7",
"account_id": "210506142216163",
"actions":
"["P2P_DELETE_RECEPIENT","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CANCEL","CHECK_MANAGEMENT","ST
OP_PAYMENT_REQUEST_VIEW","RESUME_AUTHENTICATION","STOP_PAYMENT_REQUEST_CREATE","DOMESTIC_W
IRE_TRANSFER_UPDATE_BULK_TEMPLATES","BILL_PAY_VIEW_PAYMENTS","CHECK_MANAGEMENT_VIEW_DISPUTE
D_CHECKS","DOMESTIC_WIRE_TRANSFER_VIEW_RECEPIENT","TRANSFER_BETWEEN_OWN_ACCOUNT_VIEW_RECE
PIENT","DIRECT_DEBIT_CREATE","INTER_BANK_ACCOUNT_FUND_TRANSFER_DELETE_RECEPIENT","BILL_PAY_CRE
ATE","INTRA_BANK_FUND_TRANSFER_VIEW_RECEPIENT","WITHDRAW_CASH_CARDLESS_CASH","DOMESTIC_WIRE
_TRANSFER_VIEW_BULK_TEMPLATES","INTERNATIONAL_ACCOUNT_FUND_TRANSFER_DELETE_RECEPIENT","INTER
NATIONAL_ACCOUNT_FUND_TRANSFER_VIEW_RECEPIENT","DISPUTE_TRANSACTIONS_MANAGE","INTERNATIONAL_
ACCOUNT_FUND_TRANSFER_CREATE","INTRA_BANK_FUND_TRANSFER_DELETE_RECEPIENT","VIEW_CHEQUES_VIE
W","P2P_VIEW","CHEQUE_BOOK_REQUEST_VIEW","USER_VERIFICATION","INTER_BANK_ACCOUNT_FUND_TRANSF
ER_VIEW","DOMESTIC_WIRE_TRANSFER_CREATE_RECEPIENT","INTRA_BANK_FUND_TRANSFER_VIEW","INTERNATI
ONAL_WIRE_TRANSFER_CREATE","INTERNATIONAL_WIRE_TRANSFER_CREATE_RECEPIENT","P2P_VIEW_RECEPIEN
T","VIEW_INSTALLMENT_SUMMARY","BILL_PAY_BULK","INTRA_BANK_FUND_TRANSFER_CREATE_RECEPIENT","DO](data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7)