| Bookmark Name | Actions |
|---|
Payment and Transfer
| Name | Description | Introduced In |
|---|---|---|
| oneTimeTransfer (Transfer to your own account) | This API is used to transfer amount to your own account. | 2020.04 |
| oneTimeTransfer (Transfer to another bank account) | This API is used to transfer amount to other bank account. | 2020.04 |
| oneTimeTransfer (Transfer to international accounts) | This API is used to to transfer amount to international accounts. | 2020.04 |
| createBulkTransfer | This API is used to create multiple domestic transactions at a time. | 2020.07 |
| getDomesticAccount | This API is used to get the domestic external accounts. | 2020.07 |
| TransferToOwnAccounts | This API is used to transfer amount to your account. | 2020.07 |
| TransferToOwnAccountsEdit | This API is used to edit the transaction that has occurred between your accounts. | 2020.07 |
| TransferToOwnAccountsDelete | This API is used to delete your the transaction that has occurred between your accounts. | 2020.07 |
| IntraBankAccFundTransfer | This API is used to perform an external transaction within your bank. | 2020.07 |
| IntraBankAccFundTransferEdit | This API is used to edit the external transaction that has occurred within your bank. | 2020.07 |
| IntraBankAccFundTransferDelete | This API is used to delete the external transaction that has occurred within your bank. | 2020.07 |
| InterBankAccFundTransfer | This API is used to perform a transaction with any other local bank account. | 2020.07 |
| InterBanklFundTransferEdit | This API is used to edit the transaction that has occurred with any other local bank account. | 2020.07 |
| InterBankFundTransferDelete | This API is used to delete the transaction that has occurred with any other local bank account. | 2020.07 |
| InternationalAccFundTransfer | This API is used to transfer amount to an international account. | 2020.07 |
| InternationalFundTransferEdit | This API is used to edit the international transaction. | 2020.07 |
| InternationalFundTransferDelete | This API is used to delete the international transaction. | 2020.07 |
| createABenificiary | This API is used to create a recipient. | 2020.07 |
| editExternalAccount | This API is used to edit the recipient account. | 2020.07 |
| deleteExternalPayee | This API is used to delete a recipient. | 2020.07 |
| getAllExternalAccountsWithPagination | This API is used to fetch all the recipient accounts with pagination. | 2020.07 |
| getRecentUserTransactions | This API allows the user to retrieve the recent transactions along with the supporting documents attached against a given transactionID from the underlying data source. | 2020.10 |
| createOneTimeTransfer | This API allows the user to create a one time transfer. | 2020.10 |
| getBeneficiaryName | This API allows the user to fetch the name of the beneficiary. | 2020.10 |
| addBeneficiary | This API allows the user to add the beneficiary to an account. | 2020.10 |
| getCreditCardAccounts | This API allows the user to fetch credit card accounts. | 2020.10 |
| getBankDate | This API allows the user to fetch the Banked Server Date. | 2020.10 |
| getScheduledUserTransactions | This API allows the user to fetch the scheduled transactions. | 2020.10 |
| isValidIBAN | This API allows the user to validate the International Bank Account Number (IBAN). | 2020.10 |
| getBICFromBankDetails | This API allows the user to fetch the Bank Identifier Code (BIC) from the bank. | 2020.10 |
| getSwiftCode | This API allows the user to fetch the Swift Code from the bank. | 2020.10 |
| deleteExternalAccount | This API allows the user to delete the external account. | 2020.10 |
| getBlockedFunds | This API allows the user to retrieve details of the blocked funds that are related to particular account. | 2020.10 |
oneTimeTransfer (Transfer to your own account)
| Description: | This API is used to transfer amount to your own account. |
| Method: | POST |
| URL: | /services/data/v1/RBObjects/objects/Transactions |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount that must be transferred between the accounts. FromAccountNumber (Mandatory) Specifies the account number from which the amount must be debited. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on when the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. frequencyEndDate Specifies the end date to stop the messages from being sent. (This parameter is valid only when frequencyType has been provided. toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies any additional information. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency (Mandatory) Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the Quantum Fabric service name. fromAccountCurrency Specifies the currency of account from which the amount is debited. toAccountCurrency Specifies the currency of the account to which the amount is credited. feeCurrency Specifies the currency in which the charges for making the transaction are paid. View the Request Sample Code
{
"amount": "100.00",
"frequencyEndDate": "2020-04-07T04:27:10.710Z",
"frequencyType": "Once",
"fromAccountNumber": "80195",
"isScheduled": "0",
"scheduledDate": "2020-04-07T04:27:10.709Z",
"toAccountNumber": "79987",
"transactionsNotes": "dbpolbuser_eu",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"feeCurrency": "EUR",
"MFAAttributes": {
"serviceName": "SERVICE_ID_1"
},
"fromAccountCurrency": "USD",
"toAccountCurrency": "USD"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID for each transfer payment after every successful transfer. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown . |
oneTimeTransfer (Transfer to another bank account)
| Description: | This API is used to transfer amount to other bank account. |
| Method: | POST |
| URL: | /services/data/v1/RBObjects/objects/Transactions |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount that must be transferred between the accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on when the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. frequencyEndDate Specifies the end date to stop the messages from being sent. (This parameter is valid only when frequencyType has been provided. toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies any additional information. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency (Mandatory) Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the Quantum Fabric service name. fromAccountCurrency Specifies the currency of account from which the amount is debited. toAccountCurrency Specifies the currency of the account to which the amount is credited. feeCurrency Specifies the currency in which the charges for making the transaction are paid. IBAN (Mandatory) Specifies the International bank account number. beneficiaryName Specifies the beneficiary name to whom the amount will be credited. View the Request Sample Code
{
"amount": "10.00",
"frequencyEndDate": "2020-04-07T03:44:04.854Z",
"frequencyType": "Once",
"fromAccountNumber": "80195",
"isScheduled": "0",
"scheduledDate": "2020-04-07T03:44:04.854Z",
"transactionsNotes": "dbpolbuser_eu",
"transactionType": "ExternalTransfer",
"IBAN": "GB54DEMO60161300014613",
"transactionCurrency": "USD",
"feeCurrency": "EUR",
"beneficiaryName": "Test",
"MFAAttributes": {
"serviceName": "SERVICE_ID_1"
},
"fromAccountCurrency": "USD"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of each transfer payment after every successful transfer. {
"referenceId": "PI1910703VY8TY8Q",
"isCompleted": "false",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown . |
oneTimeTransfer (Transfer to international accounts)
| Description: | This API is used to transfer amount to international accounts. |
| Method: | POST |
| URL: | /services/data/v1/RBObjects/objects/Transactions |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount to be transferred between from your own account. ExternalAccountNumber (Mandatory) Specifies the bank account number that belongs to another country. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on when the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. frequencyEndDate Specifies the end date to stop the messages from being sent. (This parameter is valid only when frequencyType has been provided. toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies any additional information. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency (Mandatory) Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the Quantum Fabric service name. fromAccountCurrency Specifies the currency of account from which the amount is debited. toAccountCurrency Specifies the currency of the account to which the amount is credited. feeCurrency Specifies the currency in which the charges for making the transaction are paid. IBAN Specifies the International bank account number. beneficiaryName Specifies the beneficiary name to whom the amount will be credited. swiftCode (Mandatory) Specifies the bank identifier code that is valid throughout the country. feePaidByReceipent Specifies the currency of the transfer charge paid by the recipient. View the Request Sample Code
{
"amount": "100.00",
"ExternalAccountNumber": "7029332",
"frequencyEndDate": "2020-04-07T05:18:56.267Z",
"frequencyType": "Once",
"fromAccountNumber": "80117",
"isScheduled": "0",
"scheduledDate": "2020-04-07T05:18:56.267Z",
"toAccountNumber": "7029332",
"transactionsNotes": "dbp********eu",
"transactionType": "ExternalTransfer",
"swiftCode": "BARCGBXX",
"bankName": "Infinity",
"transactionCurrency": "GBP",
"feeCurrency": "EUR",
"feePaidByReceipent": true,
"beneficiaryName": "test",
"MFAAttributes": {
"serviceName": "SERVICE_ID_1"
},
"fromAccountCurrency": "GBP"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of each transfer payment after every successful transfer. {
"referenceId": "PI1910703VY8TY8Q",
"isCompleted": "false",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
createBulkTransfer
| Description: | This API is used to create multiple domestic transactions at the same time. |
| Method: | Custom Verb (createBulkTransfer) |
| URL: | /services/data/v1/RBObjects/objects/Transactions |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount that must be transferred between the accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or on a monthly basis. frequencyEndDate Specifies the date at which the messages must be stopped. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency (Mandatory) Specifies the currency type of the transaction, such as USD, Euro, or Pound. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. View the Request Sample Code
{
"bulkTransferString": "[{\"fromAccountNumber\":\"190128223241502\",\"toAccountNumber\":\"98287890273\",\"transactionType\":\"ExternalTransfer\",\"amount\":\"11.00\",\"transactionCurrency\":\"GBP\",\"fromAccountCurrency\":\"GBP\",\"toAccountCurrency\":\"USD\",\"frequencyType\":\"Once\",\"feeCurrency\":\"GBP\"},{\"fromAccountNumber\":\"190128223242830\",\"toAccountNumber\":\"5528789466\",\"transactionType\":\"ExternalTransfer\",\"amount\":\"18.00\",\"transactionCurrency\":\"GBP\",\"fromAccountCurrency\":\"GBP\",\"toAccountCurrency\":\"EUR\",\"frequencyType\":\"Once\",\"isScheduled\":\"0\",\"scheduledDate\":\"2020-06-19T05:47:00.355Z\",\"feeCurrency\":\"GBP\"}]"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the bulk transfer. {
[
{"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
},
{"referenceId": "PI191070NFTKCKCU",
"opstatus": 0,
"httpStatusCode": 200
},
]
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
getDomesticAccount
| Description: | This API is used to fetch the domestic external accounts. |
| Method: | Custom Verb (getDomesticAccount) |
| URL: | services/data/v1/RBObjects/objects/ExternalAccounts |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
None |
| Response: |
Parameters /ExternalAccounts Specifies the properties of the external accounts. /ExternalAccounts/accountNumber Specifies the account number of the external account. /ExternalAccounts/IBAN Specifies the International Bank Account Number of the external account. /ExternalAccounts/beneficiaryName Specifies the name of the beneficiary to whom the amount is credited. /ExternalAccounts/createdOn Specifies the date on which the external account was created. /ExternalAccounts/Id Specifies the ID of the external account. /ExternalAccounts/beneficiaryId Specifies the ID of the beneficiary to whom the amount is credited. /ExternalAccounts/isInternationalAccount Specifies whether the account is an international account. /ExternalAccounts/isSameBankAccount Specifies whether the external account belongs to the same bank as the debitor. /ExternalAccounts/isVerified Specifies whether the fetched account is a verified account. /ExternalAccounts/nickName Specifies the nick name of the external account holder. /ExternalAccounts/accountType Specifies the type of the external account. {
"ExternalAccounts":[
{
"accountNumber":"80737",
"IBAN":"AL35202111090000000001234567",
"beneficiaryName":"",
"createdOn":"2020-06-26",
"Id":"BEN2010800008",
"beneficiaryId":"BEN2010800008",
"isInternationalAccount":"false",
"isSameBankAccount":"true",
"isVerified":"true",
"nickName":"Naks",
"accountType":"Savings"
}
],
"opstatus":0,
"httpStatusCode":200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown . |
TransferToOwnAccounts
| Description: | This API is used to transfer an amount to your account. | ||
| Method: | Custom Verb (TransferToOwnAccounts) | ||
| URL: | /services/data/v1/TransactionObjects/operations/Transaction | ||
| Security Level: | Authorized App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount that must be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. externalAccountNumber Specifies the external account number of the recipient. uploadedattachments Specifies the details of the uploaded attachments such as PDFs. View the Request Sample Code
{
"amount":"112.00",
"transactionId":"",
"frequencyType":"Once",
"fromAccountNumber":"90603",
"isScheduled":"1",
"frequencyStartDate":"2020-04-17T07:08:56.358Z",
"frequencyEndDate":"",
"scheduledDate":"2020-04-17T07:08:56.358Z",
"toAccountNumber":"GB85DEMO60161300014637",
"paymentType":"",
"paidBy":"SHA",
"swiftCode":"DEMOGBPX",
"serviceName":"",
"beneficiaryName":"",
"transactionsNotes":"",
"transactionType":"InternalTransfer",
"transactionCurrency":"EUR",
"fromAccountCurrency":"USD",
"toAccountCurrency":"USD",
"numberOfRecurrences":"",
"ExternalAccountNumber":"GB85DEMO60161300014637",
"uploadedattachments":"lec18.pdf-application/pdf-JVBERi0xLjQNJeLjz9MNCjUxMSAwIG9iag08PCANL0xpbmVhcml6ZWQgMSANL08gNTE1IA0vSCBbIDMzODUgMTgxMyBdIA0vTCAxNTkxNTk5IA0vRSA3NDM1MSANL04gNzQgDS9UIDE1ODEyNjAgDT4........"
}
|
||
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. /status Specifies the status of the transfer. /message Specifies the message based on the status of the transfer. /amount Specifies amount that is being transferred between the accounts. /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /fromAccountCurrency Specifies the currency of account from which the amount must be debited. /fromAccountNumber Specifies the Account Number from which the amount must be debited. /isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) /toAccountNumber Specifies the account number to which the amount must be credited. /transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. /transactionsNotes Specifies additional information about the transaction. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /iban Specifies the International Bank Account Number. /swiftCode Specifies the swift code for international transactions. /feeCurrency Specifies the currency in which the fees must be paid. /paidBy Specifies the name of the payee. /paymentType Specifies the type of payment. /serviceName Specifies the name of the service that is used for performing the transfer. /charges Specifies an array of charges and the corresponding details. /exchangeRate Specifies the exchange rate for the transfer /totalAmount Specifies the total amount that is transferred. {
"referenceId": "PI201080D9CN7JW8",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "14",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "80942",
"isScheduled": "0",
"scheduledDate": "2020-04-17T08:40:54Z",
"toAccountNumber": "346823",
"transactionCurrency": "USD",
"transactionsNotes": "Red",
"transactionType": "InternalTransfer",
"iban": "346823",
"swiftCode": "",
"feeCurrency": "USD",
"paidBy": "SHA",
"paymentType": "SEPA",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"overrides": "[{\"id\":\"PI-SIM.OFF.FX.INVOLVE1\",\"message\":\"The rate calculated is a reference rate and not actual rate\"}]",
"charges": "[{\"chargeType\":\"TXNFEE\",\"chargeAmount\":1200,\"chargeName\":\"Transaction Fees\",\"chargeCurrency\":\"USD\"}]",
"exchangeRate": "1.153062",
"totalAmount": "12.14"
}
|
||
| Error Code(s): | EB.ERROR - Table errors will be thrown. | ||
| Associated Services: |
|
TransferToOwnAccountsEdit
| Description: | This API is used to edit the transaction that has occurred between your accounts. |
| Method: | Custom Verb (TransferToOwnAccountsEdit) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
transactionId (Mandatory) Specifies the ID of the transaction that must be edited. amount (Mandatory) Specifies the amount that must be transferred between you're own accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. View the Request Sample Code
{
"amount": "42.00",
"frequencyEndDate":"2020-06-15T05:47:00.355Z",
"frequencyStartDate":"2020-06-11T05:47:00.355Z",
"frequencyType": "Daily",
"fromAccountNumber": "80624",
"isScheduled": "1",
"toAccountNumber": "91006",
"transactionId": "80624.45",
"transactionsNotes": "None",
"transactionType": "InternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
TransferToOwnAccountsDelete
| Description: | This API is used to delete the transaction that has occurred between your accounts. |
| Method: | Custom Verb (TransferToOwnAccountsDelete) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters transactionId (Mandatory) Specifies the ID of the transaction that must be deleted. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. {
"transactionId": "PI564123716834",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
IntraBankAccFundTransfer
| Description: | This API is used to perform an external transaction within your bank. | ||
| Method: | Custom Verb (IntraBankAccFundTransfer) | ||
| URL: | /services/data/v1/TransactionObjects/operations/Transaction | ||
| Security Level: | Authorized App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount that must be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount is debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount is credited. uploadedattachments Specifies the details of the uploaded attachments such as PDFs. View the Request Sample Code
{
"amount":"1.03",
"frequencyEndDate":"2020-06-09T05:47:00.355Z",
"frequencyType":"Once",
"fromAccountNumber":"80624",
"isScheduled":"0",
"scheduledDate":"2020-06-09T05:47:00.355Z",
"toAccountNumber":"80322",
"transactionsNotes":"",
"transactionType":"ExternalTransfer",
"transactionCurrency":"GBP",
"fromAccountCurrency":"GBP",
"ExternalAccountNumber":"",
"uploadedattachments":"lec18.pdf-application/pdf-JVBERi0xLjQNJeLjz9MNCjUxMSAwIG9iag08PCANL0xpbmVhcml6ZWQgMSANL08gNTE1IA0vSCBbIDMzODUgMTgxMyBdIA0vTCAxNTkxNTk5IA0vRSA3NDM1MSANL04gNzQgDS9UIDE1ODEyNjAgDT4+IA1lbmRvYmoNICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB4cmVmDTUxMSA5MSANMDAwMDAwMDAxNiAwMDAwMCBuDQowMDAwMDAyMTg5IDAwMDAwIG4NCjAwMDAwMDI1NTkgMDAwMDAgbg0KMDAwMDAwMjcxMC.............."
}
|
||
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
||
| Error Code(s): | EB.ERROR - Table errors will be thrown. | ||
| Associated Services: |
|
IntraBankAccFundTransferEdit
| Description: | This API is used to edit the external transaction that has occurred within your bank. |
| Method: | Custom Verb (IntraBankAccFundTransferEdit) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
transactionId (Mandatory) Specifies the ID of the transaction that must be edited. amount (Mandatory) Specifies the amount to be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. View the Request Sample Code
{
"amount": "0.41",
"description": "Transfer To Addinternationalacc",
"frequencyEndDate":"2020-06-15T05:47:00.355Z",
"frequencyStartDate":"2020-06-12T05:47:00.355Z",
"frequencyType": "Daily",
"fromAccountNumber": "80624",
"isScheduled": "1",
"toAccountNumber": "80322",
"transactionId": "80624.48",
"transactionsNotes": "None",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the edited transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
IntraBankAccFundTransferDelete
| Description: | This API is used to delete the transaction that has occurred between your accounts. |
| Method: | Custom Verb (IntraBankAccFundTransferDelete) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters transactionId (Mandatory) Specifies the ID of the transaction that must be deleted. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. {
"transactionId": "PI564123716834",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the deleted transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
InterBankAccFundTransfer
| Description: | This API is used to perform a transaction with any other local bank account. | ||
| Method: | Custom Verb (InterBankAccFundTransfer) | ||
| URL: | /services/data/v1/TransactionObjects/operations/Transaction | ||
| Security Level: | Authorized App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount to be transferred between the two accounts. duration (Mandatory) Specifies the duration required for the transfer. externalAccountNumber (Mandatory) Specifies the external account number. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. swiftCode (Mandatory) Specifies the swift code details of other . View the Request Sample Code
{
"amount": "14", "attributeMap": {},
"duration": "","endCalendarDate": "",
"ExternalAccountNumber": "GB63DEMO60161300011638",
"feeCurrency": "USD", "frequencyEndDate": "",
"frequencyStartDate": "","frequencyType": "Once",
"fromAccountBalance": "34000","fromAccountCurrency": "USD",
"fromAccountName": "Current Account",
"fromAccountNumber": "80942",
"fromAccountType": "Checking","fromBankName": "Model Bank",
"fromProcessedName": "OLB Curre...1081",
"iban": "GB63DEMO60161300011638",
"isRecipientAdded": false,"isScheduled": "0",
"numberOfRecurrences": "","paidBy": "SHA",
"paymentMedium": "Normal Payment","paymentType": "SEPA",
"scheduledCalendarDate": "04/17/2020",
"scheduledDate": "2020-04-17T08:40:54.808Z",
"swiftCode": "DEMOGBPX","toAccountName": "Karthik",
"toAccountNumber": "GB63DEMO60161300011638",
"toProcessedName": "Karthik...4637","transactionCurrency": "USD",
"transactionsNotes": "Red",
"transactionType": "ExternalTransfer","validate": "false",
"uploadedattachments": "lec18.pdf-application/pdf-JVBERi0xLjQNJeLjz9MNCjUxMSAwIG9iag08PCANL0xpbmVhcml6ZWQgMSANL08gNTE1IA0vSCBbIDMzODUgMTgxMyBdIA0vTCAxNTkxNTk5IA0vRSA3NDM1MSANL04gNzQgDS9UIDE1ODEyNjAgDT4"} |
||
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. /status Specifies the status of the transfer. /message Specifies the message based on the status of the transfer. /amount Specifies amount that is being transferred between the accounts. /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /fromAccountCurrency Specifies the currency of account from which the amount must be debited. /fromAccountNumber Specifies the Account Number from which the amount must be debited. /isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) /toAccountNumber Specifies the account number to which the amount must be credited. /transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. /transactionsNotes Specifies additional information about the transaction. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /iban Specifies the International Bank Account Number. /swiftCode Specifies the swift code for international transactions. /feeCurrency Specifies the currency in which the fees must be paid. /paidBy Specifies the name of the payee. /paymentType Specifies the type of payment. /serviceName Specifies the name of the service that is used for performing the transfer. /charges Specifies an array of charges and the corresponding details. /exchangeRate Specifies the exchange rate for the transfer /totalAmount Specifies the total amount that is transferred.
{
"referenceId": "PI201080D9CN7JW8",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "14",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "80942",
"isScheduled": "0",
"scheduledDate": "2020-04-17T08:40:54Z",
"toAccountNumber": "GB63DEMO60161300011638",
"transactionCurrency": "USD",
"transactionsNotes": "Red",
"transactionType": "ExternalTransfer",
"iban": "GB63DEMO60161300011638",
"swiftCode": "DEMOGBPX",
"feeCurrency": "USD",
"paidBy": "SHA",
"paymentType": "SEPA",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"overrides": "[{\"id\":\"PI-SIM.OFF.FX.INVOLVE1\",\"message\":\"The rate calculated is a reference rate and not actual rate\"}]",
"charges": "[{\"chargeType\":\"TXNFEE\",\"chargeAmount\":1200,\"chargeName\":\"Transaction Fees\",\"chargeCurrency\":\"USD\"}]",
"exchangeRate": "1.153062",
"totalAmount": "12.14"
}
|
||
| Error Code(s): | EB.ERROR - Table errors will be thrown. | ||
| Associated Services: |
|
InterBankFundTransferEdit
| Description: | This API is used to edit the transaction that has occurred with any other local bank account. |
| Method: | Custom Verb (InterBankFundTransferEdit) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
transactionId (Mandatory) Specifies the ID of the transaction that must be edited. amount (Mandatory) Specifies the amount to be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. View the Request Sample Code
{
"amount": "0.46",
"description": "Transfer To Addinternationalacc",
"frequencyEndDate":"2020-06-15T05:47:00.355Z",
"frequencyStartDate":"2020-06-12T05:47:00.355Z",
"frequencyType": "Daily",
"fromAccountNumber": "80624",
"isScheduled": "1",
"toAccountNumber": "123456",
"transactionId": "80624.53",
"transactionsNotes": "None",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the edited transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
InterBankFundTransferDelete
| Description: | This API is used to delete the transaction that has occurred with any other local bank account. |
| Method: | Custom Verb (InterBankFundTransferDelete) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters transactionId (Mandatory) Specifies the ID of the transaction that must be deleted. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. {{
"transactionId": "PI564123716834",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the deleted transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
InternationalAccFundTransfer
| Description: | This API is used to transfer amount to an international account. | ||
| Method: | Custom Verb (InternationalAccFundTransfer) | ||
| URL: | /services/data/v1/TransactionObjects/operations/Transaction | ||
| Security Level: | Authorized App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
View the Request Parameters
amount (Mandatory) Specifies the amount to be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. swiftCode (Mandatory) Specifies the bank identifier code that is valid throughout the country. numberOfRecurrences Specifies the number of recurrent international transactions. ExternalAccountNumber Specifies the external account number to perform international transactions. uploadedattachments Specifies the details of the uploaded attachments such as PDFs. View the Request Sample Code
{
"amount":"112.00",
"transactionId":"",
"frequencyType":"Once",
"fromAccountNumber":"90603",
"isScheduled":"1",
"frequencyStartDate":"2020-04-17T07:06:59.058Z",
"frequencyEndDate":"",
"scheduledDate":"2020-04-17T07:06:59.058Z",
"toAccountNumber":"IL170108000000012612345",
"paymentType":"",
"paidBy":"",
"swiftCode":"UNBKILIT",
"serviceName":"",
"beneficiaryName":"",
"transactionsNotes":"",
"transactionType":"ExternalTransfer",
"transactionCurrency":"EUR",
"fromAccountCurrency":"USD",
"toAccountCurrency":"USD",
"numberOfRecurrences":"",
"ExternalAccountNumber":"IL170108000000012612345",
"uploadedattachments":"lec18.pdf-application/pdf-JVBERi0xLjQNJeLjz9MNCjUxMSAwIG9iag08PCANL0xpbmVhcml6ZWQgMSANL08gNTE1IA0vSCBbIDMzODUgMTgxMyBdIA0vTCAxNTkxNTk5IA0vRSA3NDM1MSANL04gNzQgDS9UIDE1ODEyNjAgDT4+IA1lbmRvYmoNICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICB4cmVmDTUxMS..............."
}
|
||
| Response: |
Parameters /referenceId Specifies the unique ID of the transfer. /status Specifies the status of the transfer. /message Specifies the message based on the status of the transfer. /amount Specifies amount that is being transferred between the accounts. /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /fromAccountCurrency Specifies the currency of account from which the amount must be debited. /fromAccountNumber Specifies the Account Number from which the amount must be debited. /isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) /toAccountNumber Specifies the account number to which the amount must be credited. /transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. /transactionsNotes Specifies additional information about the transaction. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /iban Specifies the International Bank Account Number. /swiftCode Specifies the swift code for international transactions. /feeCurrency Specifies the currency in which the fees must be paid. /paidBy Specifies the name of the payee. /paymentType Specifies the type of payment. /serviceName Specifies the name of the service that is used for performing the transfer. /charges Specifies an array of charges and the corresponding details. /exchangeRate Specifies the exchange rate for the transfer /totalAmount Specifies the total amount that is transferred. {
"referenceId": "PI201080D9CN7JW8",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "14",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "80942",
"isScheduled": "0",
"scheduledDate": "2020-04-17T08:40:54Z",
"toAccountNumber": "IL63DEMO60161300011638",
"transactionCurrency": "USD",
"transactionsNotes": "Red",
"transactionType": "ExternalTransfer",
"iban": "IL63DEMO60161300011638",
"swiftCode": "DEMOGBPX",
"feeCurrency": "USD",
"paidBy": "SHA",
"paymentType": "SEPA",
"serviceName": "INTERNATIONAL_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"overrides": "[{\"id\":\"PI-SIM.OFF.FX.INVOLVE1\",\"message\":\"The rate calculated is a reference rate and not actual rate\"}]",
"charges": "[{\"chargeType\":\"TXNFEE\",\"chargeAmount\":1200,\"chargeName\":\"Transaction Fees\",\"chargeCurrency\":\"USD\"}]",
"exchangeRate": "1.153062",
"totalAmount": "12.14"
}
|
||
| Error Code(s): | EB.ERROR - Table errors will be thrown. | ||
| Associated Services: |
|
InternationalFundTransferEdit
| Description: | This API is used to edit the international transaction. |
| Method: | Custom Verb (InternationalFundTransferEdit) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
View the Request Parameters
transactionId (Mandatory) Specifies the ID of the transaction that must be edited. amount (Mandatory) Specifies the amount to be transferred between the two accounts. FromAccountNumber (Mandatory) Specifies the Account Number from which the amount must be debited. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) frequencyType (Mandatory) Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the end date to stop the messages from being sent. (This parameter is valid only when frequencyType has been provided. toAccountNumber (Mandatory) Specifies the account number to which the amount must be credited. transactionsNotes Specifies additional information about the transaction. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. fromAccountCurrency (Mandatory) Specifies the currency of account from which the amount must be debited. toAccountCurrency (Mandatory) Specifies the currency of the account to which the amount must be credited. View the Request Sample Code
{
"amount": "0.48",
"description": "Transfer To Addinternationalacc",
"frequencyEndDate":"2020-06-15T05:47:00.355Z",
"frequencyStartDate":"2020-06-12T05:47:00.355Z",
"frequencyType": "Daily",
"fromAccountNumber": "80624",
"isScheduled": "1",
"toAccountNumber": "GB38DEMO60161312386315",
"transactionId": "80624.55",
"transactionsNotes": "None",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the edited transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
InternationalFundTransferDelete
| Description: | This API is used to delete the international transaction. |
| Method: | Custom Verb (InternationalFundTransferDelete) |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters transactionId (Mandatory) Specifies the ID of the transaction that must be deleted. transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. {
"transactionId": "PI564123716834",
"transactionType": "ExternalTransfer"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID of the deleted transaction. {
"referenceId": "PI191070NFTKCKCJ",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
createABenificiary
| Description: | This API is used to create a recipient. |
| Method: | Custom Verb (createABenificiary) |
| URL: | services/data/v1/RBObjects/objects/ExternalAccounts |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters IBAN (Mandatory) Specifies the International Bank Account Number of the recipient. nickName Specifies the nick name of the recipient. isSameBankAccount (Mandatory) Specifies whether the recipient's bank account type is same as yours. isInternationalAccount (Mandatory) Specifies whether the account is an international account. beneficiaryName (Mandatory) Specifies the name of the beneficiary. {
"beneficiaryName":"Hemanth",
"isInternationalAccount":false,
"isSameBankAccount":false,
"nickName":"Hem",
"IBAN":"GB85DEMO60161300014637"
}
|
| Response: |
Parameters /Id Specifies the unique ID of the beneficiary. {
"Id":"BEN2010800104",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
editExternalAccount
| Description: | This API is used to edit the recipient account. |
| Method: | Custom Verb (editExternalAccount) |
| URL: | {{URL}}/services/data/v1/RBObjects/operations/ExternalAccounts/editExternalAccount |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters accountNumber (Mandatory) Specifies the account number of the recipient. nickName Specifies the nick name of the recipient. beneficiaryName Specifies the name of the beneficiary/recipient. IBAN Specifies the International Bank Account Number of the recipient. country Specifies the name of the country. zipcode Specifies the zip-code. {
"accountNumber":"GB85DEMO60161300014637",
"nickName":"abcc",
"beneficiaryName":"Sujathaa,
"IBAN":"GB63DEMO60161300011638",
"country":"Great Britian","addressLine1":"abc",
"zipcode":"123456",
"city":"london"
}
|
| Response: |
Parameters /success Specifies whether the operation was a success. /externalAccount Specifies an array of external account details. /externalAccount/accountNumber Specifies the external account number. /externalAccount/beneficiaryName Specifies the name of the beneficiary. /externalAccount/swiftCode Specifies the swift code. /externalAccount/IBAN Specifies the International Bank Account Number. /externalAccount/Id Specifies the unique ID of the external account. {
"success": "success",
"externalaccount": [
{
"accountNumber": "IL170108000000012612345",
"beneficiaryName": "Sujatha",
"swiftCode": "UNBKILIT",
"IBAN": "IL170108000000012612345",
"Id": "BEN2010800146"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
deleteExternalPayee
| Description: | This API is used to delete a recipient. |
| Method: | Custom Verb (deleteExternalPayee) |
| URL: | services/data/v1/RBObjects/objects/ExternalAccounts |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters IBAN (Mandatory) Specifies the International Bank Account Number of the recipient. Id (Mandatory) Specifies the ID of the recipient. {
"IBAN":"GB85DEMO60161300014637",
"Id":"BEN2010800020"
}
|
| Response: |
Parameters /Id Specifies the unique ID of the recipient. {
"Id":"BEN2010800008",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown. |
getAllExternalAccountsWithPagination
| Description: | This API allows you to fetch all the recipient accounts with pagination. |
| Method: | Custom Verb (getAllExternalAccountsWithPagination) |
| URL: | services/data/v1/RBObjects/objects/ExternalAccounts |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters limit (Mandatory) Specifies the ending index of the sorted records that are used in pagination. offset (Mandatory) Specifies the starting index of the sorted records that are used in pagination. sortby (Mandatory) Specifies the sorting criteria for the response such as amount or transactionDate. order (Mandatory) Specifies the sorting order for the response (Ascending/Descending). {
"limit":"10",
"offset":"0",
"orderby":"desc",
"sortby":"transactionDate"
}
|
| Response: |
Parameters /ExternalAccounts Specifies the properties of the external accounts. /ExternalAccounts/accountNumber Specifies the account number of the external account. /ExternalAccounts/beneficiaryName Specifies the name of the beneficiary to whom the amount is credited. /ExternalAccounts/createdOn Specifies the date on which the external account was created. /ExternalAccounts/Id Specifies the ID of the external account. /ExternalAccounts/beneficiaryId Specifies the ID of the beneficiary to whom the amount is credited. /ExternalAccounts/isInternationalAccount Specifies whether the account is an international account. /ExternalAccounts/isSameBankAccount Specifies whether the external account belongs to the same bank as the debtor. /ExternalAccounts/isVerified Specifies whether the account is a verified account. /ExternalAccounts/nickName Specifies the nick name of the external account holder. /ExternalAccounts/accountType Specifies the type of the external account. {
"ExternalAccounts":[
{
"accountNumber":"80737",
"beneficiaryName":"",
"createdOn":"2020-06-26",
"Id":"BEN2010800008",
"beneficiaryId":"BEN2010800008",
"isInternationalAccount":"false",
"isSameBankAccount":"true",
"isVerified":"true",
"nickName":"Naks",
"accountType":"Savings"
}
],
"opstatus":0,
"httpStatusCode":200
}
|
| Error Code(s): | EB.ERROR - Table errors will be thrown . |
getRecentUserTransactions
| Description: | This API allows the user to retrieve the recent transactions along with the supporting documents attached against a given transactionID from the underlying data source. | ||
| Method: | Custom Verb | ||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Transactions/getRecentUserTransactions | ||
| Security Level: | Authenticated App Users | ||
| Header Request: |
|
||
| Body Request: |
None |
||
| Response: |
Parameters /amount Specifies the amount that must be transferred between the accounts. /category Specifies the category of the transaction. /description Specifies the description of the transaction. /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. /fromAccountBalance Specifies the balance of amount in the account from which the amount gets debited. /fromAccountName Specifies the name of the account from which the amount gets debited. /fromAccountNumber Specifies the account number from which the amount gets debited. /fromAccountType Specifies the type of account from which the amount gets debited. /fromNickName Specifies the nick name of the account. /hasDepositImage Specifeis whether the account has a deposit image. The value is Boolean. /isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /numberOfRecurrences Specifies the number of recurrent transactions. /statusDescription Specifies the status description. /toAccountName Specifies the name of the account to which the amount must be credited. /toAccountNumber Specifies the account number to which the amount must be credited. /toAccountType Specifies the type of the account to which the amount must be credited. /transactionDate Specifies the date on which the transation has taken place. /transactionId Specifies the unique ID generated for the transaction. /transactionsNotes Specifies the additional transactions. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /fee Specifies the fee amount. /isBusinessPayee Specifies whether the payee is a business payee. The value is Boolean. /fileNames
/fileNames/fileName Specifies the name of the file. /fileNames/fileID Specifies the name of the file. View the Sample Response Code for Mock Services
{
"amount":"500.00",
"category":"Uncategorised",
"description":"Online ",
"frequencyType":"Once",
"fromAccountBalance":"4170.78",
"fromAccountName":"Rewards Savings",
"fromAccountNumber":"190128223241502",
"fromAccountType":"Savings",
"fromNickName":"My Checking",
"hasDepositImage":"false",
"isScheduled":"false",
"numberOfRecurrences":"0",
"statusDescription":"Successful",
"toAccountName":"Core Checking",
"toAccountNumber":"190128223242830",
"toAccountType":"Checking",
"transactionDate":"2020-09-28T08:27:41Z",
"transactionId":"12108",
"transactionsNotes":"",
"transactionType":"InternalTransfer",
"fee":"0.00",
"isBusinessPayee":"0",
"fileNames":[
{
"fileName":"1637906901.pdf",
"fileID":"u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
}
]
}
View the Sample Response Code for Transact Services
{
"Transactions": [
{
"chargeBearer": "SHA",
"amount": "75000",
"systemId": "BNK20079KHKLC0GJ",
"fromAccountNumber": "81965",
"transactionCurrency": "USD",
"fromAccountName": "Mortgage Loan",
"currentStatus": "Complete",
"endToEndReference": "NOTPROVIDED",
"scheduledDate": "2020-03-19",
"versionNumber": "2",
"fromAccountIBAN": "",
"transactionId": "PI200790CGVG6L2N",
"transactionType": "ExternalTransfer",
"paymentCurrencyId": "USD",
"toAccountName": "Harry Crisp Ac",
"fromAccountCurrency": "USD",
"orderingCustomerId": "100100",
"toAccountNumber": "76848",
"frequencyType": "Once",
"paymentStatus": "ACSC",
"isScheduled": "false",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"fileNames": [
{
"fileName": "1637906901.pdf",
"fileID": "u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
}
]
},
{
"chargeBearer": "SHA",
"amount": "11",
"systemId": "BNK20108JMJKLFKL",
"fromAccountNumber": "91057",
"transactionCurrency": "EUR",
"fromAccountName": "Virat Savings",
"currentStatus": "Complete",
"endToEndReference": "NOTPROVIDED",
"scheduledDate": "2020-04-17",
"versionNumber": "2",
"fromAccountIBAN": "GB32DEMO60161300091057",
"transactionId": "PI20108000733W55",
"transactionType": "ExternalTransfer",
"paymentCurrencyId": "EUR",
"toAccountName": "Kazak",
"fromAccountCurrency": "USD",
"ExternalAccountNumber": "457475",
"orderingCustomerId": "100336",
"toAccountNumber": "457475",
"frequencyType": "Once",
"paymentStatus": "RJCT",
"isScheduled": "false",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"fileNames": []
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||
| Service Flow: |
|
createOneTimeTransfer
| Description: | This API allows the user to create a one time transfer. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Transactions/createOneTimeTransfer | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters amount Specifies the amount that must be transferred between the accounts. transactionID Specifies the unique ID of the transaction. frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. fromAccountNumber Specifies the account number from which the amount gets debited. isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. frequencyStartDate Specifies the date on which messages must start being sent. (This parameter is valid only when frequencyType has been provided. frequencyEndDate Specifies the date on which the messages must stop being sent. (This parameter is valid only when frequencyType has been provided). scheduledDate Specifies the date on which the scheduled transfer payment must occur (This parameter is valid only if the isScheduled parameter is set to true) toAccountNumber Specifies the account number to which the amount must be credited. paymentType Specifies the type of payment. paidBy Specifies name of the user who is paying the amount. swiftCode Specifies the Swift code for international transactions. transactionsNotes Specifies the additional notes. transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionCurrency Specifies the currency type of the transaction such as USD, Euro, or Pound. fromAccountCurrency Specifies the currency of account from which the amount is debited. toAccountCurrency Specifies the currency of the account to which the amount is credited. numberOfRecurrences Specifies the number of recurrent transactions that have to be made. ExternalAccountNumber Specifies the account number of the external account. uploadedattachments Specifies the uploaded transactions. beneficiaryName Specifies the name of beneficiary serviceName Specifies the name of the service used for performing the transaction. {
"amount":"1.00",
"transactionId":"",
"frequencyType":"Once",
"fromAccountNumber":"79812",
"isScheduled":"0",
"frequencyStartDate":"2021-05-04T11:33:13.337Z",
"frequencyEndDate":"",
"scheduledDate":"2021-05-04T11:33:13.337Z",
"toAccountNumber":"79995",
"paymentType":"",
"paidBy":"SHA",
"swiftCode":"",
"transactionsNotes":"",
"transactionType":"InternalTransfer",
"transactionCurrency":"EUR",
"fromAccountCurrency":"USD",
"toAccountCurrency":"EUR",
"numberOfRecurrences":"",
"ExternalAccountNumber":"79995",
"uploadedattachments":"",
"validate":"true",
"beneficiaryName":"Current Acc",
"serviceName":"TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE"
}
|
|||||
| Response: |
Parameters /chargeBearer Specifies the name of the user who bears the charges. /charges Specifies an array of charges and the corresponding details. /body Specifies the JSON object that contains various details regarding the transfer /referenceId Specifies the unique ID that gets generated after initiating the transfer. /status Specifies the status of the transfer. {
"chargeBearer": "SHA",
"charges": "[{\"chargeType\":\"TXNFEE\",\"chargeAmount\":1200,
\"chargeName\":\"Transaction Fees\",\"chargeCurrency\":\"USD\"},
{\"chargeType\":\"TTTFR\",\"chargeAmount\":1,
\"chargeName\":\"Transfer Charges\",\"chargeCurrency\":\"USD\"},
{\"chargeType\":\"BROKERFEE\",\"chargeAmount\":0.05,
\"chargeName\":\"Broker Fee\",\"chargeCurrency\":\"USD\"}]",
"opstatus": 0,
"overrides": "[{\"id\":\"PI-BIC.IS.NOT.REACHABLE\",\"message\":\"Bic/NCC provided is not Reachable\"}]",
"body": "{chargeBearer=SHA, amount=1, debitCurrency=USD, endToEndReference=NOTPROVIDED, beneficiaryIBAN=GB63DEMO60161300011638, executionDate=2020-04-17, debitAccountId=79812, orderingCustomerName=Virat Kohli Virat Kohli, overrides=[{\"override\":\"PI-BIC.IS.NOT.REACHABLE}Bic\\/NCC provided is not Reachable\"}], accountWithBankBIC=DEMOGBPX, paymentCurrencyId=USD, charges=[{\"chargeType\":\"TXNFEE\",\"chargeAmount\":1200,\"chargeName\":\"Transaction Fees\",\"chargeCurrency\":\"USD\"},{\"chargeType\":\"TTTFR\",\"chargeAmount\":1,\"chargeName\":\"Transfer Charges\",\"chargeCurrency\":\"USD\"},{\"chargeType\":\"BROKERFEE\",\"chargeAmount\":0.05,\"chargeName\":\"Broker Fee\",\"chargeCurrency\":\"USD\"}], orderingCustomerId=100229, debitAccountIBAN=GB37DEMO60161300079812, beneficiaryName=Sujathaa, paymentOrderProductId=SEPA}",
"referenceId": "PI2010809YGRC88L",
"status": "success",
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getBeneficiaryName
| Description: | This API allows the user to fetch the name of the beneficiary. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/ExternalAccounts/getBeneficiaryName | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters accountNumber Specifies the account number of the beneficiary. {
"accountNumber": "1234567890"
}
|
|||||
| Response: |
Parameters /beneficiaryName Specifies the name of the beneficiary. {
"beneficiaryName": "Constellation Energy Group",
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
AddBeneficiary
| Description: | This API allows the user to add the beneficiary to an account. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/objects/ExternalAccounts | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters bankName Specifies the name of the bank. beneficiaryName Specifies the name of the beneficiary. isInternationalAccount Specifies whether the account is an international account. The value is Boolean. isSameBankAccount Specifies whether the account belongs to the same bank. The value is Boolean. nickName Specifies the nick name of the beneficiary. swiftCode Specifies the swift code for international transactions. IBAN Specifies the International Bank Account Number. country Specifies the country in which the beneficiary resides. addressLine1 Specifies the first line of address of the beneficiary. zipcode Specifies the zip-code of the beneficiary. city Specifies the city in which the city is located. {
"bankName":"DEMO BIC FOR MODEL BANK",
"beneficiaryName":"Sujathaa",
"isInternationalAccount":false,
"isSameBankAccount":false,
"nickName":"Sujathaa",
"swiftCode":"DEMOGBPX",
"IBAN":"GB63DEMO60161300011638",
"country":"Great Britian",
"addressLine1":"abc","addressLine2":"def",
"zipcode":"123456",
"city":"london"
}
|
|||||
| Response: |
Parameters /id Specifies the unique ID that gets generated after the beneficiary gets added to the account. {
"Id": "BEN2010800150",
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getCreditCardAccounts
| Description: | This API allows the user to fetch credit card accounts. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Accounts/getCreditCardAccouts | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
None |
|||||
| Response: |
Parameters /accountID Specifies the unique ID of the credit card account. /accountName Specifies the name of the account. /accountType Specifies the type of account such as Savings, Credit, Loan, and so on. /currencyCode Specifies the unique code for the currency that is used in the application. /dueDate Specifies the due date for repayment of the credit due. /minimumDue Specifies minimum due of the user for the credit account. /nickName Specifies the nick name of the credit account. /outstandingBalance Specifies the outstanding balance that the user has availed from the credit account. /paymentDue Specifies the amount that the user is due. {
"accountID": "2901282",
"accountName": "HDFC Credit Card",
"accountType": "CreditCard",
"currencyCode": "USD",
"dueDate": "2020-11-10T00:00:00",
"minimumDue": "276.0",
"nickName": "HDFC Credit",
"outstandingBalance": "629.61",
"paymentDue": "3726.0",
"AccountName": "HDFC Credit Card"
}
|
|||||
| Service Flow: |
|
getBankDate
| Description: | This API allows the user to fetch the Banked Server Date. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Transactions/getBankDate | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
None |
|||||
| Response: |
Parameters /date Specifies an array of details on the bank date. /date/companyId Specifies the ID of the company. /date/lastWorkingDate Specifies the last working date of the bank. /date/nextWorkingDate Specifies the working date for the bank /date/currentWorkingDate Specifies the current working date of the bank. {
"date": [
{
"companyId": "GB0010001",
"lastWorkingDate": "2020-04-16",
"nextWorkingDate": "2020-04-20",
"currentWorkingDate": "2020-04-17"
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getScheduledUserTransactions
| Description: | This API allows the user to fetch the scheduled transactions. | ||||||||||||
| Method: | Custom Verb | ||||||||||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Transactions/getScheduledUserTransactions | ||||||||||||
| Security Level: | Authenticated App Users | ||||||||||||
| Header Request: |
|
||||||||||||
| Body Request: |
Parameters firstRecordNumber Specifies the index number of the first record. lastRecordNumber Specifies the index number of the last record. pageStart Specifies the starting index number for the page. {
"firstRecordNumber": "1",
"lastRecordNumber": "10",
"pageStart": “1”
}
|
||||||||||||
| Response: |
Parameters /amount Specifies the amount that must be transferred between the accounts. /category Specifies the category of the transaction. /description Specifies the description of the transaction. /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made daily, weekly, or on a monthly basis. /fromAccountBalance Specifies the balance of amount in the account from which the amount gets debited. /fromAccountName Specifies the name of the account from which the amount gets debited. /fromAccountNumber Specifies the account number from which the amount gets debited. /fromAccountType Specifies the type of account from which the amount gets debited. /fromNickName Specifies the nick name of the account. /hasDepositImage Specifeis whether the account has a deposit image. The value is Boolean. /isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /numberOfRecurrences Specifies the number of recurrent transactions. /statusDescription Specifies the status description. /toAccountName Specifies the name of the account to which the amount must be credited. /toAccountNumber Specifies the account number to which the amount must be credited. /toAccountType Specifies the type of the account to which the amount must be credited. /transactionDate Specifies the date on which the transation has taken place. /transactionId Specifies the unique ID generated for the transaction. /transactionsNotes Specifies the additional transactions. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /fee Specifies the fee amount. /isBusinessPayee Specifies whether the payee is a business payee. The value is Boolean. /fileNames Specifies an array of files (Records of Scheduled Transactions) /fileNames/fileName Specifies the name of the file. /fileNames/fileId Specifies the unique ID of the file. View the Sample Response Code for Mock Services
{
"Transactions": [
{
"amount": "66.00",
"category": "Uncategorised",
"description": "Person2PersonTransfer to Rahul",
"frequencyType": "Monthly",
"fromAccountBalance": "6949.78",
"fromAccountName": "Rewards Savings",
"fromAccountNumber": "190128223241502",
"fromAccountType": "Savings",
"fromNickName": "My Checking",
"hasDepositImage": "false",
"isScheduled": "true",
"numberOfRecurrences": "3",
"payPersonEmail": "",
"payPersonName": "Rahul",
"payPersonPhone": "7890654312",
"recurrenceDesc": "1 of 3",
"scheduledDate": "2023-05-02T12:00:00Z",
"statusDescription": "Pending",
"toAccountNumber": "",
"transactionDate": "2020-10-12T04:54:20Z",
"transactionId": "20210",
"transactionsNotes": "",
"transactionType": "P2P",
"fee": "0.00",
"transactionCurrency": "USD",
"serviceName": "P2P_CREATE",
"isBusinessPayee": "0",
"personId": "1483",
"fileNames": [
{
"fileName": "1637906901.pdf",
"fileID": "u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
}
]
},
{
"amount": "120.00",
"category": "Uncategorised",
"description": "Transfer To My Checking",
"frequencyEndDate": "2020-10-30T12:00:00Z",
"frequencyType": "Weekly",
"fromAccountBalance": "2487.69",
"fromAccountName": "Core Checking",
"fromAccountNumber": "190128223242830",
"fromAccountType": "Checking",
"fromNickName": "My Checking",
"hasDepositImage": "false",
"isScheduled": "true",
"numberOfRecurrences": "0",
"scheduledDate": "2020-10-15T12:00:00Z",
"statusDescription": "Pending",
"toAccountName": "Rewards Savings",
"toAccountNumber": "190128223241502",
"toAccountType": "Savings",
"transactionDate": "2020-10-12T06:03:39Z",
"transactionId": "20213",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"fee": "0.00",
"transactionCurrency": "USD",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"isBusinessPayee": "0",
"fileNames": []
}],
"opstatus": 0,
"httpStatusCode": 0
}
View the Sample Response Code for Transact Services
{
"Transactions": [
{
"amount": "45",
"description": "Transfer To Brice Bamford",
"ExternalAccountNumber": "79847",
"frequencyEndDate": "2020-04-24",
"frequencyStartDate": "2020-04-18",
"frequencyType": "Daily",
"fromAccountName": "Savings Account",
"fromAccountNumber": "90603",
"isScheduled": "true",
"scheduledDate": "2020-04-18",
"toAccountName": "Brice Bamford",
"toAccountNumber": "79847",
"transactionDate": "2020-04-18",
"transactionId": "90603.11",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
"payeeCurrency": "USD",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"beneficaryName": "Brice Bamford",
"fileNames": []
},
{
"amount": "1",
"description": "Transfer To domestic",
"frequencyStartDate": "2020-04-20",
"frequencyType": "Once",
"fromAccountName": "Diana Cooper",
"fromAccountNumber": "90689",
"isScheduled": "true",
"scheduledDate": "2020-04-20",
"toAccountName": "domestic",
"toAccountNumber": "GB54DEMO60161300014613",
"transactionDate": "2020-04-20",
"transactionId": "PI201081580C4CTH",
"transactionType": "ExternalTransfer",
"payeeCurrency": "USD",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"fileNames": [
{
"fileName": "1637906901.pdf",
"fileID": "u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
}
]
}
],
"opstatus": 0,
"httpStatusCode": 200
}
|
||||||||||||
| Associated Services: |
|
isValidIBAN
| Description: | This API allows the user to validate the International Bank Account Number (IBAN). | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/Transactions/isValidIBAN | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters IBAN Specifies the International Bank Account Number. {"IBAN":"IL170108000000012612345"}
|
|||||
| Response: |
Parameters /IBAN Specifies the International Bank Account Number /isIBANValid Specifies whether the International Bank Account Number is valid (Yes/No). {
"IBAN": "IL170108000000012612345",
"isIBANValid": "YES",
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getBICFromBankDetails
| Description: | This API allows the user to fetch the Bank Identifier Code (BIC) from the bank. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/SwiftCode/getBICFromBankDetails | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters bankName Specifies the name of the bank. country Specifies the name of the country. city Specifies the name of the city. {
"bankName":"",
"country":"AFRICA",
"city":""
}
|
|||||
| Response: |
Parameters /swiftCodes Specifies an array of swift code details. /swiftCodescountry Specifies the name of the country. /swiftCodescity Specifies the name of the city. /swiftCodesbankName Specifies the name of the bank. /swiftCodesbic Specifies the Bank Identifier Code. {
"opstatus": 0,
"swiftCodes": [
{
"country": "SOUTH AFRICA",
"city": "JOHANNESBURG",
"bankName": "ANGLO AMERICAN SA FINANCE LIMITED",
"bic": "AACLZAJJXXX"
}
],
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getSwiftCode
| Description: | This API allows the user to fetch the Swift Code from the bank. | |||||||
| Method: | Custom Verb | |||||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/SwiftCode/getSwiftCode | |||||||
| Security Level: | Authenticated App Users | |||||||
| Header Request: |
|
|||||||
| Body Request: |
Parameters iban Specifies the International Bank Account Number. countryCode Specifies the code of the country. {
"iban":"IL170108000000012612345",
"countryCode":"IL"
}
|
|||||||
| Response: |
Parameters /country Specifies the name of the country. /sepaMember Specifies whether the country is part of Single Euro Payments Area. /bankName Specifies the name of the bank. /bic Specifies the Bank Identifier Code. {
"country": "ISRAEL",
"sepaMember": "N",
"bankName": "UNION BANK OF ISRAEL LTD",
"bic": "UNBKILIT",
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||||
| Service Flow: |
|
deleteExternalAccount
| Description: | This API allows the user to delete the external account. | |||||
| Method: | Custom Verb | |||||
| URL: | {{URL}}/services/data/v1/RBObjects/operations/ExternalAccounts/ deleteExternalAccount | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters accountNumber Specifies the external account number. {
"accountNumber": "GB63DEMO60161300011638"
}
|
|||||
| Response: |
Parameters /success Specifies the success message. /Id Specifies the ID generated after deleting the account. {
"success": "success",
"Id": "BEN2010800180",
"opstatus": 0,
"httpStatusCode": 200
}
|
|||||
| Service Flow: |
|
getBlockedFunds
| Description: | This API allows the user to retrieve details of the blocked funds that are related to particular account. |
| Method: | POST |
| URL: | {URL}/ services/data/v1/RBObjects/operations/Transactions/getBlockedFunds |
| Security Level: | Authenticated App Users |
| Header Request: |
|
| Body Request: |
Parameters accountID (Mandatory) Specifies the account number for which blocked funds details must be fetched. lockedEventId Specifies the locked event (transaction reference) based on which the details are fetched. lockReason Specifies the reason for which the funds have been blocked. Based on the reason, the details are fetched. searchStartDate Specifies the start date from when the details must be fetched. searchEndDate Specifies the end date up to when the details must be fetched. {
"accountID":"89907",
"lockedEventId":"ACLK2010813942",
"lockReason":"Locked by tph",
"searchStartDate":"20200410",
"searchEndDate":"20200420"
}
|
| Response: |
Parameters /Transactions Specifies an array of JSON Objects related to transactions. /Transactions/fromDate Specifies the start date from when the the account had been blocked. /Transactions/lockedAmount Specifies the value of the amount that has been blocked. /Transactions/transactionReference Specifies the alternate reference id for the transaction that is locked. /Transactions/toDate Specifies the end date up to when the account had been blocked.. /Transactions/lockedEventId Specifies the reference id for the transaction that is locked. /Transactions/lockReason Specifies the reason for which the amount has been locked. "Transactions": [
{
"fromDate": "2020-04-16",
"lockedAmount": "333.00",
"transactionReference": "ACLK2010813942",
"toDate": "2020-04-30",
"lockedEventId": "ACLK2010813942",
"lockReason": "Locked by tph"
},
{
"fromDate": "2020-04-30",
"lockedAmount": "444.00",
"transactionReference": "ACLK2010820311",
"toDate": "2020-05-21",
"lockedEventId": "ACLK2010820311",
"lockReason": "kaasu illa"
}
]
|
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?