| Bookmark Name | Actions |
|---|
Transaction
| Name | Description | Introduced In |
|---|---|---|
| BillPayTransfer | This API allows the user to create a Bill Pay transfer. | 2020.04 |
| BulkBillPayTransfer | This API allows the user to perform a Bill Pay transfer in bulk. | 2020.04 |
| P2PTransfer | This API allows the user to perform a Person-To-Person transfer. | 2020.04 |
| InterBankAccFundTransfer | This API allows the user to perform a transaction with any other local bank account. | 2020.07 |
| InternationalAccFundTransfer | This API allows the user to transfer the amount to an international account. | 2020.07 |
| TransferToOwnAccounts | This API allows the user to transfer the amount to your account. | 2020.07 |
| IntraBankAccFundTransfer | This API allows the user to perform an external transaction within your bank. | 2020.07 |
| DomesticWireTransfer | This API allows the user to perform a domestic wire transfer. | 2020.04 |
| InternationalWireTransfer | This API allows the user to perform an international wire transfer. | 2020.04 |
| GetTransactionsByBulkWireFileExecutionId | This API allows the user to fetch the execution details of the bulk wire transaction. | 2020.04 |
| getBulkWireFilesForUser | This API allows the user to fetch the bulk wire files that are created by the user. | 2020.04 |
| GetBulkWireFileTransactionDetail | This API allows the user to fetch the transaction details from a bulk wire file. | 2020.04 |
| getBulkwireFileLineItems | This API allows the user to fetch the details of a bulk wire file (Line Items). | 2020.04 |
| createDisputedTransaction | This API allows the user to lodge a dispute for any posted transaction. | 2020.04 |
| getPostedDeposit | This API allows the user to fetch the deposit of a logged-in user. | 2020.04 |
| getPostedTransferAndP2pTransaction | This API allows the user to fetch the Person-To-Person transactions of the logged-in user. | 2020.04 |
| getPostedUserTransaction | This API allows the user to fetch the posted transactions of the logged in user. | 2020.04 |
| getRecentUserTransaction | This API allows the user to fetch the recent user transactions. | 2020.04 |
| getUserScheduledTransaction | This API allows the user to fetch the scheduled user transactions. | 2020.04 |
BillPayTransfer
| Description: | This API is used to create a Bill Pay transfer. |
| Method: | POST |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction/BillPayTransfer |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters amount Specifies the amount that must be transferred between the two accounts. fromAccountNumber Specifies the account number from which the amount must be debited. transactionsNotes Specifies additional information about the transaction. scheduledDate Specifies the date on which the scheduled transfer payment must occur transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. deliverBy Specifies the date by which the transfer must be completed. toAccountNumber Specifies the account number to which the amount must be credited. zipCode Specifies the zip code of the payee. billerId Specifies the unique ID of the biller. {
"amount": "12.00",
"fromAccountNumber": "190128223241502",
"transactionsNotes": "",
"scheduledDate": "2020-03-30T13:15:28.649Z",
"transactionType": "BillPay",
"deliverBy": "2020-03-30T13:15:28.644Z",
"toAccountNumber": "123",
"zipCode": "12312",
"billerId": "1"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID generated for the Bill Pay transfer. /status Specifies the status of the Bill Pay transfer (Sent/Pending/Failure). /message Specifies the message that is based on the status of the transfer. /amount Specifies the amount that is transferred between the two accounts. /billerId Specifies the unique ID of the biller. /deliverBy Specifies the date by which the transfer must be completed. /fromAccountNumber Specifies the account number from which the amount must be debited. /scheduledDate Specifies the date on which the scheduled transfer payment must occur /toAccountNumber Specifies the account number to which the amount must be credited. /transactionsNotes Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /zipCode Specifies the zip code of the payee. /serviceName Specifies the name of the service that is used for performing Bill Pay transfer. {
"referenceId": "115",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "12",
"billerId": "1",
"deliverBy": "2020-03-30T13:15:28.644Z",
"fromAccountNumber": "190128223241502",
"scheduledDate": "2020-03-30T13:15:28.649Z",
"toAccountNumber": "123",
"transactionsNotes": "",
"transactionType": "BillPay",
"zipCode": "12312",
"serviceName": "BILL_PAY_CREATE"
}
|
BulkBillPayTransfer
| Description: | This API is used to perform a Bill Pay transfer in bulk. |
| Method: | POST |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction/BulkBillPayTransfer |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters bulkPayString Specifies an array of details that are required for performing a bulk Bill Pay transfer. {
"bulkPayString": "[{\"fromAccountNumber\":\"190128223241502\",\"scheduledDate\":\"2020-03-30T13:13:46.095Z\",\"Bill_id\":\"0\",\"payeeId\":\"1732\",\"amount\":\"12.00\",\"deliverBy\":\"2020-03-30T13:13:46.095Z\",\"transactionsNotes\":\"\"},{\"fromAccountNumber\":\"190128223241502\",\"scheduledDate\":\"2020-03-30T13:13:46.095Z\",\"Bill_id\":\"0\",\"payeeId\":\"1731\",\"amount\":\"10.00\",\"deliverBy\":\"2020-03-30T13:13:46.095Z\",\"transactionsNotes\":\"\"}]"
}
|
| Response: |
Parameters /Transactions Specifies an array of transactions involved in the Bulk Bill Pay transfer and the corresponding details. /Transactions/referenceId Specifies the unique ID generated for the Bulk Bill Pay transfer. /Transactions/status Specifies the status of the Bulk Bill Pay transfer (Sent/Pending/Failure). /Transactions/message Specifies the message that is based on the status of the transfer. /Transactions/amount Specifies the amount that is transferred between the two accounts. /Transactions/deliverBy Specifies the date by which the transfer must be completed. /Transactions/fromAccountNumber Specifies the account number from which the amount must be debited. /Transactions/payeeId Specifies the unique ID of the payee. /Transactions/scheduledDate Specifies the date on which the scheduled transfer payment must occur /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. {
"Transactions": [{
"referenceId": "113",
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "12",
"deliverBy": "2020-03-30T13:13:46.095Z",
"fromAccountNumber": "190128223241502",
"payeeId": "1732",
"scheduledDate": "2020-03-30T13:13:46.095Z",
"transactionType": "BillPay"
}, {
"referenceId": "114",
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "10",
"deliverBy": "2020-03-30T13:13:46.095Z",
"fromAccountNumber": "190128223241502",
"payeeId": "1731",
"scheduledDate": "2020-03-30T13:13:46.095Z",
"transactionType": "BillPay"
}],
"opstatus": 0,
"httpStatusCode": 0
}
|
P2PTransfer
| Description: | This API is used to perform a Person-To-Person transfer. |
| Method: | POST |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction/P2PTransfer |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters amount Specifies the amount that is transferred between the two accounts. frequencyEndDate Specifies the date at which the messages must be stopped. (This parameter is valid only when frequencyType has been provided). frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly. 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. p2pContact Specifies the number for performing the Person-To-Person transfer. personId Specifies the unique ID of the person to whom the amount must be transferred. 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) transactionsNotes Specifies additional information about the transaction. 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 the account, from which the amount must be debited. {
"amount": "2.00",
"frequencyEndDate": "2020-01-27T07:35:41.349Z",
"frequencyType": "Once",
"fromAccountNumber": "190128223241502",
"isScheduled": "0",
"p2pContact": "8790146356",
"personId": "1467",
"scheduledDate": "2020-01-27T07:35:41.349Z",
"transactionsNotes": "test",
"transactionType": "P2P",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID generated for the Person-To-Person transfer. /status Specifies the status of the Person-To-Person transfer (Sent/Pending/Failure). /message Specifies the message that is based on the status of the transfer. /amount Specifies the amount that is transferred between the two accounts. /frequencyEndDate Specifies the date at which the messages must be stopped. (This parameter is valid only when frequencyType has been provided). /frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly . /fromAccountNumber Specifies the account number from which the amount must be debited. /fromAccountCurrency Specifies the currency of the account, from which the amount must be debited. p2pContact Specifies the number for performing the Person-To-Person transfer. personId Specifies the unique ID of the person to whom the amount must be transferred. /scheduledDate Specifies the date on which the scheduled transfer payment must occur. transactionCurrency Specifies the currency type of the transaction, such as USD, Euro, or Pound. /transactionsNotes Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /serviceName Specifies the name of the service that is used for performing Bill Pay transfer. {
"referenceId": "203",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "2",
"frequencyEndDate": "2020-01-27T07:35:41.349Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "190128223241502",
"isScheduled": "0",
"p2pContact": "8790146356",
"personId": "1467",
"scheduledDate": "2020-01-27T07:35:41.349Z",
"transactionCurrency": "USD",
"transactionsNotes": "test",
"transactionType": "P2P",
"serviceName": "P2P_CREATE"
}
|
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. 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 swift code details of other . View the Request Sample Code
{"amount":"1.91",
"frequencyStartDate":"2020-06-10T05:47:00.355Z",
"frequencyType":"Once",
"fromAccountNumber":"80624",
"isScheduled":"0",
"scheduledDate":"2020-06-10T05:47:00.355Z",
"toAccountNumber":"NL88INGB0007151798",
"transactionsNotes":"",
"transactionType":"ExternalTransfer",
"transactionCurrency":"GBP",
"fromAccountCurrency":"GBP",
"toAccountCurrency":"EUR",
"ExternalAccountNumber":"NL88INGB0007151798"
}
|
| 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. |
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. View the Request Sample Code
{
"amount":"1.03",
"frequencyEndDate":"2020-06-09T05:47:00.355Z",
"frequencyType":"Once",
"fromAccountNumber":"80624",
"isScheduled":"1",
"scheduledDate":"2020-06-09T05:47:00.355Z",
"toAccountNumber":"GB38DEMO60161312386315",
"transactionsNotes":"",
"transactionType":"ExternalTransfer",
"transactionCurrency":"GBP",
"fromAccountCurrency":"GBP",
"ExternalAccountNumber":"GB38DEMO60161312386315",
"swiftCode": "CITIUS33"
}
|
| 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. |
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. 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":"91006",
"transactionsNotes":"","transactionType":"InternalTransfer",
"transactionCurrency":"GBP","fromAccountCurrency":"GBP",
"toAccountCurrency":"EUR","feeCurrency":"GBP",
"ExternalAccountNumber":""}
{"amount":"1.03","frequencyEndDate":"2020-06-29T05:47:00.355Z",
"frequencyType":"Once","fromAccountNumber":"80934","isScheduled":"1",
"scheduledDate":"2020-06-19T05:47:00.355Z","toAccountNumber":"81272",
"transactionsNotes":"","transactionType":"InternalTransfer",
"transactionCurrency":"GBP","fromAccountCurrency":"GBP",
"toAccountCurrency":"USD","feeCurrency":"GBP",
"ExternalAccountNumber":""}
|
| 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. MFAAttributes/serviceName Specifies the name of the Quantum Fabric service. 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. 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":""
}
|
| 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. |
DomesticWireTransfer
| Description: | This API is used to perform a domestic wire transfer. |
| Method: | POST |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction/DomesticWireTransfer |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters amount Specifies the amount that must be transferred between the two accounts. fromAccountNumber Specifies the account number from which the amount must be debited. payeeAccountNumber Specifies the account number to which the amount must be credited. payeeAddressLine1 Specifies the first line of address of the payee. payeeName Specifies the name of the payee. transactionsNotes Specifies additional information about the transaction. transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. payeeCurrency Specifies the currency that the payee uses for performing the transaction. wireAccountType Specifies the type of wire account (Domestic/International). bankName Specifies the name of the bank. routingNumber Specifies the routing number. zipCode Specifies the zip code of the payee. cityName Specifies the name of the city in which the payee resides. state Specifies the name of the state in which the payee resides. bankAddressLine1 Specifies the first line of address of the payee. bankAddressLine2 Specifies the second line of address of the payee. bankCity Specifies the name of the city in which the bank is located. bankState Specifies the name of the state in which the bank is located. bankZip Specifies the zip code of the bank. payeeType Specifies the type of payee. payeeAddressLine2 Specifies the second line of address of the payee. {
"amount": "1.00",
"fromAccountNumber": "190128223241502",
"payeeAccountNumber": "123",
"payeeAddressLine1": "test",
"payeeName": "test",
"payeeNickName": "test",
"transactionsNotes": "test",
"transactionType": "Wire",
"payeeCurrency": "Dollar",
"wireAccountType": "Domestic",
"bankName": "test",
"routingNumber": "123",
"zipCode": "123",
"cityName": "test",
"state": "Telangana",
"bankAddressLine1": "test",
"bankAddressLine2": "test",
"bankCity": "test",
"bankState": "Telangana",
"bankZip": "123",
"payeeType": "Business",
"payeeAddressLine2": "test"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID generated for the Bill Pay transfer.. /status Specifies the status of the Bill Pay transfer (Sent/Pending/Failure). /message Specifies the message that is based on the status of the transfer. /amount Specifies the amount that is transferred between the two accounts. /bankAddressLine1 Specifies the first line of address of the payee. /bankAddressLine2 Specifies the second line of address of the payee. /bankName Specifies the name of the bank. /bankCity Specifies the name of the city in which the bank is located. /bankState Specifies the name of the state in which the bank is located. /bankZip Specifies the zip code of the bank. cityName Specifies the name of the city in which the payee resides. /fromAccountNumber Specifies the account number from which the amount must be debited. payeeAccountNumber Specifies the account number to which the amount must be credited. payeeAddressLine1 Specifies the first line of address of the payee. payeeAddressLine2 Specifies the second line of address of the payee. payeeName Specifies the name of the payee. payeeNickName Specifies the nickname of the payee. payeeType Specifies the type of payee. routingNumber Specifies the routing number. state Specifies the name of the state in which the payee resides. transactionsNotes Specifies additional information about the transaction. transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. wireAccountType Specifies the type of wire account (Domestic/International). /zipCode Specifies the zip code of the payee. /serviceName Specifies the name of the service that is used for performing Bill Pay transfer. {
"referenceId": "3134",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "1",
"bankAddressLine1": "test",
"bankAddressLine2": "test",
"bankCity": "test",
"bankName": "test",
"bankState": "Telangana",
"bankZip": "123",
"cityName": "test",
"fromAccountNumber": "190128223241502",
"payeeAccountNumber": "123",
"payeeAddressLine1": "test",
"payeeAddressLine2": "test",
"payeeCurrency": "Dollar",
"payeeName": "test",
"payeeNickName": "test",
"payeeType": "Business",
"routingNumber": "123",
"state": "Telangana",
"transactionsNotes": "test",
"transactionType": "Wire",
"wireAccountType": "Domestic",
"zipCode": "123",
"serviceName": "DOMESTIC_WIRE_TRANSFER_CREATE"
}
|
InternationalWireTransfer
| Description: | This API is used to perform a international wire transfer. |
| Method: | POST |
| URL: | /services/data/v1/TransactionObjects/operations/Transaction/InternationalWireTransfer |
| Security Level: | Authorized App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters amount Specifies the amount that must be transferred between the two accounts. fromAccountNumber Specifies the account number from which the amount must be debited. payeeAccountNumber Specifies the account number to which the amount must be credited. payeeAddressLine1 Specifies the first line of address of the payee. payeeName Specifies the name of the payee. payeeNickName Specifies the nickname of the payee. transactionsNotes Specifies additional information about the transaction. transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. payeeCurrency Specifies the currency that the payee uses for performing the transaction. swiftCode Specifies the swift code of the bank for international transactions. wireAccountType Specifies the type of wire account (Domestic/International). country Specifies the name of the country in which the payee resides. bankName Specifies the name of the bank. internationalRoutingNumber Specifies the international routing number. zipCode Specifies the zip code of the payee. cityName Specifies the name of the city in which the payee resides. state Specifies the name of the state in which the payee resides. bankAddressLine1 Specifies the first line of address of the payee. bankAddressLine2 Specifies the second line of address of the payee. bankCity Specifies the name of the city in which the bank is located. bankState Specifies the name of the state in which the bank is located. bankZip Specifies the zip code of the bank. payeeType Specifies the type of payee. payeeAddressLine2 Specifies the second line of address of the payee. {
"amount":"1.00",
"fromAccountNumber":"200418153056775",
"payeeAccountNumber":"123",
"payeeAddressLine1":"test",
"payeeName":"test",
"payeeNickName":"test",
"transactionsNotes":"test",
"transactionType":"Wire",
"payeeCurrency":"Dollar",
"swiftCode":"123",
"wireAccountType":"International",
"country":"United States of America",
"bankName":"test",
"internationalRoutingCode":"123",
"zipCode":"123",
"cityName":"test",
"state":"Telangana",
"bankAddressLine1":"test",
"bankAddressLine2":"test",
"bankCity":"test",
"bankState":"Telangana",
"bankZip":"123",
"payeeType":"Business",
"payeeAddressLine2":"test"
}
|
| Response: |
Parameters /referenceId Specifies the unique ID generated for the Bill Pay transfer.. /status Specifies the status of the Bill Pay transfer (Sent/Pending/Failure). /message Specifies the message that is based on the status of the transfer. /amount Specifies the amount that is transferred between the two accounts. /bankAddressLine1 Specifies the first line of address of the payee. /bankAddressLine2 Specifies the second line of address of the payee. /bankName Specifies the name of the bank. /bankCity Specifies the name of the city in which the bank is located. /bankState Specifies the name of the state in which the bank is located. /bankZip Specifies the zip code of the bank. cityName Specifies the name of the city in which the payee resides. /fromAccountNumber Specifies the account number from which the amount must be debited./ payeeAccountNumber Specifies the account number to which the amount must be credited. payeeAddressLine1 Specifies the first line of address of the payee. payeeAddressLine2 Specifies the second line of address of the payee. /payeeName Specifies the name of the payee. /payeeNickName Specifies the nickname of the payee. /payeeType Specifies the type of payee. /routingNumber Specifies the routing number. /state Specifies the name of the state in which the payee resides. /transactionsNotes Specifies additional information about the transaction. /transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /wireAccountType Specifies the type of wire account (Domestic/International). /zipCode Specifies the zip code of the payee. /serviceName Specifies the name of the service that is used for performing Bill Pay transfer. {
"referenceId": "182",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Pending",
"message": "Needs approval",
"amount": "1",
"bankAddressLine1": "test",
"bankAddressLine2": "test",
"bankCity": "test",
"bankName": "test",
"bankState": "Telangana",
"bankZip": "123",
"cityName": "test",
"country": "United States of America",
"fromAccountNumber": "200418153056775",
"internationalRoutingCode": "123",
"payeeAccountNumber": "123",
"payeeAddressLine1": "test",
"payeeAddressLine2": "test",
"payeeCurrency": "Dollar",
"payeeName": "test",
"payeeNickName": "test",
"payeeType": "Business",
"state": "Telangana",
"swiftCode": "123",
"transactionsNotes": "test",
"transactionType": "Wire",
"wireAccountType": "International",
"zipCode": "123"
}
|
GetTransactionsByBulkWireFileExecutionId
| Description: | This API allows the user to fetch the execution details of the bulk wire transaction. | ||
| Method: | POST | ||
| URL: | services/data/v1/BulkWireObjects/operations/BulkWireTransaction/getTransactionsByBulkWireFileExecutionId | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters BulkWireFileExecution_id Specifies the unique ID for the bulk wire execution ID. sortByParam Specifies the field that must be sorted. By default, the payees will be sorted based on the date of creation. sortOrder Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default the value is set to ascending searchString Specifies the string value to search the fields file name. statusFilter Specifies the filter for status. {
"BulkWireFileExecution_id":"1",
"sortByParam":"",
"sortOrder":"",
"searchString":"",
"statusFilter":""
}
|
||
| Response: |
Parameters /BulkWireFileExecutionDetails Specifies an array of Bulk Wire Execution details. /BulkWireFileExecutionDetails/Domestic Specifies an array of Domestic details. /BulkWireFileExecutionDetails/Domestic/amount Specifies the domestic amount. /BulkWireFileExecutionDetails/Domestic/bankAddressLine1 Specifies the first line of bank's address. /BulkWireFileExecutionDetails/Domestic/bankAddressLine2 Specifies the second line of bank's address. /BulkWireFileExecutionDetails/Domestic/bankCity Specifies the name of the city in which the bank is located. /BulkWireFileExecutionDetails/Domestic/bankName Specifies the name of the bank. /BulkWireFileExecutionDetails/Domestic/bankState Specifies the name of the state in which the bank is located. /BulkWireFileExecutionDetails/Domestic/cityName Specifies the name of the city. /BulkWireFileExecutionDetails/Domestic/country Specifies the name of the country. /BulkWireFileExecutionDetails/Domestic/fromAccountNumber Specifies the account number from which the amount is debited. /BulkWireFileExecutionDetails/Domestic/internationalRoutingCode Specifies the international routing code. /BulkWireFileExecutionDetails/Domestic/notes Specifies the additional notes. /BulkWireFileExecutionDetails/Domestic/onetime_id Specifies the unique ID of the one time transfer. /BulkWireFileExecutionDetails/Domestic/payeeAccountNumber Specifies the account number of the payee. /BulkWireFileExecutionDetails/Domestic/payeeAddressLine1 Specifies the first line of address of the bank. /BulkWireFileExecutionDetails/Domestic/payeeAddressLine2 Specifies the second line of address of the bank. /BulkWireFileExecutionDetails/Domestic/payeeCurrency Specifies the currency in which the payee is located. /BulkWireFileExecutionDetails/Domestic/payeeNickName Specifies the nickname of the payee. /BulkWireFileExecutionDetails/Domestic/payeeType Specifies the type of payee. /BulkWireFileExecutionDetails/Domestic/state Specifies the name of the state. /BulkWireFileExecutionDetails/Domestic/status Specifies the status of the transaction. /BulkWireFileExecutionDetails/Domestic/swiftCode Specifies the swift code for international /BulkWireFileExecutionDetails/Domestic/transactionId Specifies the unique ID of the transaction. /BulkWireFileExecutionDetails/Domestic/transactionType Specifies the type of transaction. /BulkWireFileExecutionDetails/Domestic/wireAccountType Specifies the type of wire account. /BulkWireFileExecutionDetails/Domestic/wireFileExecution_id Specifies the unique ID of the wire file execution. /BulkWireFileExecutionDetails/Domestic/zipCode Specifies the zipcode. /BulkWireFileExecutionDetails/failedCount Specifies the number of the failed counts. /BulkWireFileExecutionDetails/pendingCount Specifies the number of the pending counts. /BulkWireFileExecutionDetails/successCount Specifies the number of success counts. /BulkWireFileExecutionDetails/totalCount Specifies the total number of counts. /BulkWireFileExecutionDetails/pendingCount Specifies the number of pending count. BulkWireFileExecutionDetails: [{
Domestic: [{
amount: "2.34"
bankAddressLine1: "Bankaddress2"
bankAddressLine2: "bankaddressline22"
bankCity: "Hyderabad"
bankName: "recipientBank2"
bankState: "Telangana"
cityName: "Hyderabad"
country: "India"
fromAccountNumber: "200929043904310"
internationalRoutingCode: "456183"
notes: "2nd records"
onetime_id: "170"
payeeAccountNumber: "1234537"
payeeAddressLine1: "recipientAddressLine12"
payeeAddressLine2: "recipientAddressline22"
payeeCurrency: "GBP"
payeeName: "wer"
payeeNickName: "wer"
payeeType: "Business"
state: "Telangana"
status: "Denied"
swiftCode: "abc124"
transactionId: "170"
transactionType: "Wire"
wireAccountType: "Domestic"
wireFileExecution_id: "1"
zipCode: "500081"]}
International: [{
amount: "1.22"
bankAddressLine1: "Bankaddress5"
bankAddressLine2: "bankaddressline25"
bankCity: "Hyderabad"
bankName: "recipientBank5"
bankState: "Telangana"
cityName: "Hyderabad"
country: "India"
fromAccountNumber: "200929043904310"
internationalRoutingCode: "456186"
notes: "5th records"
onetime_id: "167"
payeeAccountNumber: "1234540"
payeeAddressLine1: "recipientAddressLine15"
payeeAddressLine2: "recipientAddressline25"
payeeCurrency: "EUR"
payeeName: "ewr"
payeeNickName: "ewr"
payeeType: "Individual"
state: "Telangana"
status: "Denied"
swiftCode: "abc127"
transactionId: "167"
transactionType: "Wire"
wireAccountType: "International"
wireFileExecution_id: "1"
zipCode: "500081"}]
failedCount: "4"
pendingCount: "0"
successCount: "0"
totalCount: "4"
httpStatusCode: 0
opstatus: 0}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
GetBulkWiresFilesForUser
| Description: | This API allows the user to fetch the bulk wire files that are created by the user. | ||
| Method: | POST | ||
| URL: | services/data/v1/BulkWireObjects/operations/BulkWire/getBulkWiresFilesForUser | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters pageOffset Specifies the row from where the data must be retreived. The offset value is often used together with the limit. sortByParam Specifies the field that must be sorted. By default, the payees will be sorted based on the date of creation. sortOrder Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default the value is set to ascending searchString Specifies the string value such as nickname, firstname, lastname, and name to search the fields file name. pageSize This API specifies the number of rows that must be returned in the result. {
"pageOffset":0,
"sortByParam":"",
"sortOrder":"",
"searchString":"",
"pageSize":10
}
|
||
| Response: |
Parameters /BulkWiresFiles Specifies an array of Bulk Wire Files and the corresponding details. /BulkWiresFiles/bulkWireCategory Specifies the category name of the bulk wire. /BulkWiresFiles/bulkWireID Specifies the unique ID of the bulk wire files /BulkWiresFiles/bulkWireName Specifies the name of the bilk wire. /BulkWiresFiles/lastmodifiedts Specifies the last modified time stamp for the bulk wire file. /BulkWiresFiles/firstname Specifies the first name of the user. /BulkWiresFiles/lastname Specifies the last name of the user. /BulkWiresFiles/noOfDomesticTransactions Specifies the number of domestic transactions. /BulkWiresFiles/\noOfInternationalTransactions Specifies the number of international transactions. {
BulkWiresFiles: [{
bulkWireCategory: "Files"
bulkWireID: "xXTpNFjI-ERZ7V7bp-RlQM8d7i-ezzD8Eyu"
bulkWireName: "SampleBulkWireFile_2020-09-29T09:10:28.xls"
createdts: "2020-09-29T20:10:28Z"
firstname: "John"
lastmodifiedts: "2020-09-29T20:10:28Z"
lastname: "Doe"
noOfDomesticTransactions: "1"
noOfInternationalTransactions: "3"
noOfTransactions: "4"}]
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
GetBulkWireFileTransactionDetail
| Description: | This API allows the user to fetch the transaction details from a bulk wire file. | ||
| Method: | POST | ||
| URL: | services/data/v1/BulkWireObjects/operations/BulkWireTransaction/GetBulkWireFileTransactionDetail | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters bulkWireFileID (Mandatory) Specifies the unique ID of the bulk wire file of which, the transaction details must be fetched. pageOffset Specifies the row from where the data must be retreived. The offset value is often used together with the limit. pageSize Specifies the number of rows that must be returned in the result. {
"bulkWireFileID":"xXTpNFjI-ERZ7V7bp-RlQM8d7i-ezzD8Eyu",
"pageOffset":0,
"pageSize":10
}
|
||
| Response: |
Parameters /BulkWireFileTransactDetails Specifies an array of Bulk Wires JSONObject file transaction details. /BulkWireFileTransactDetails/bulkWireFileID Specifies the unique ID of the bulk wire file. /BulkWireFileTransactDetails/createdts Specifies the created time stamp. /BulkWireFileTransactDetails/firstname Specifies the first name of the user who performed the transaction. /BulkWireFileTransactDetails/initiatedBy Specifies the unique ID of the user who initiated the transaction. /BulkWireFileTransactDetails/lastmodifiedts Specifies the time stamp on which the transaction details were last modified /BulkWireFileTransactDetails/lastname Specifies the last name of the user who performed the transaction. /BulkWireFileTransactDetails/totalCountOfDomesticTransactions Specifies the number of total domestic transactions performed through the Bulk Wire file. /BulkWireFileTransactDetails/\totalCountOfInternationalTransactions Specifies the total number of international transactions performed through the Bulk Wire file.. /BulkWireFileTransactDetails/\totalCountOfTransactions Specifies the total number of transactions performed through the Bulk Wire file. /BulkWireFileTransactDetails/\transactionDate Specifies the date on which the transaction occurred. {
BulkWireFileTransactDetails: [{
bulkWireFileID: "xXTpNFjI-ERZ7V7bp-RlQM8d7i-ezzD8Eyu"
bulkWireFileID: "1"
createdts: "2020-09-29T11:43:15Z"
firstname: "John"
initiatedBy: "1525111101"
lastmodifiedts: "2020-09-29T11:43:15Z"
lastname: "Doe"
totalCountOfDomesticTransactions: "1"
totalCountOfInternationalTransactions: "3"
totalCountOfTransactions: "4"
transactionDate: "2020-09-29T11:43:15Z"}]
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getBulkwireFileLineItems
| Description: | This API allows the user to fetch the details of a bulk wire file (Line Items). | ||
| Method: | POST | ||
| URL: | services/data/v1/BulkWireObjects/operations/BulkWireFile/getBulkwireFileLineItems | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters bulkWireFileID (Mandatory) Specifies the unique ID of the bulk wire file of which, the transaction details must be fetched. sortBy Specifies the row from where the data must be retreived. The offset value is often used together with the limit. order Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending. searchString Specifies a string value to search fields such as nickname, firstname, lastname, name and so on. {
"bulkWireFileID":"xXTpNFjI-ERZ7V7bp-RlQM8d7i-ezzD8Eyu",
"sortBy":"",
"order":"",
"searchString":""
}
|
||
| Response: |
View the Response Parameters
/BulkWireFileLineItems Specifies an array of Bulk Wire File Line Item details. /BulkWireFileLineItems/Domestic Specifies an array of Domestic Line Item details. /BulkWireFileLineItems/Domestic/amount Specifies the amount that is to be transferred. /BulkWireFileLineItems/Domestic/bulkWireFileLineItemID Specifies the unique ID of the Bulk Wire File Line Item. /BulkWireFileLineItems/Domestic/bulkWireTransferType Specifies the transfer type for the Bulk Wire File. /BulkWireFileLineItems/Domestic/currency Specifies the currency that is to be used during transactions. /BulkWireFileLineItems/Domestic/internationalRoutingNumber Specifies the international routing number. /BulkWireFileLineItems/Domestic/note Specifies the additional notes. /BulkWireFileLineItems/Domestic/recipientAccountNumber Specifies the account number of the recepient. /BulkWireFileLineItems/Domestic/recipientAddressLine1 Specifies the first line of address of the recipient. /BulkWireFileLineItems/Domestic/recipientAddressLine2 Specifies the second line of address of the recipient. /BulkWireFileLineItems/Domestic/recipientBankAddress1 Specifies the first line of the bank address. /BulkWireFileLineItems/Domestic/recipientBankAddress2 Specifies the second line of the bank address. /BulkWireFileLineItems/Domestic/recipientBankName Specifies the name of the bank. /BulkWireFileLineItems/Domestic/recipientBankcity Specifies the name of the city in which the bank is located. /BulkWireFileLineItems/Domestic/recipientBankstate Specifies the state in which the bank is located. /BulkWireFileLineItems/Domestic/recipientCity Specifies the city in which the bank is located. /BulkWireFileLineItems/Domestic/recipientCountryName Specifies the name of the country in which the recipient resides. /BulkWireFileLineItems/Domestic/recipientName Specifies the name of the recipient. /BulkWireFileLineItems/Domestic/recipientState Specifies the state in which the recipient resides. /BulkWireFileLineItems/Domestic/recipientZipCode Specifies the zip-code. /BulkWireFileLineItems/Domestic/routingNumber Specifies the domestic routing number. /BulkWireFileLineItems/Domestic/swiftCode Specifies the swift code. /BulkWireFileLineItems/Domestic/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /BulkWireFileLineItems/International Specifies an array of Domestic Line Item details. /BulkWireFileLineItems/International/amount Specifies the amount that is to be transferred. /BulkWireFileLineItems/International/bulkWireFileLineItemID Specifies the unique ID of the Bulk Wire File Line Item. /BulkWireFileLineItems/International/bulkWireTransferType Specifies the transfer type for the Bulk Wire File. /BulkWireFileLineItems/International/currency Specifies the currency that is to be used during transactions. /BulkWireFileLineItems/International/internationalRoutingNumber Specifies the international routing number. /BulkWireFileLineItems/International/note Specifies the additional notes. /BulkWireFileLineItems/International/recipientAccountNumber Specifies the account number of the recepient. /BulkWireFileLineItems/International/recipientAddressLine1 Specifies the first line of address of the recipient. /BulkWireFileLineItems/International/recipientAddressLine2 Specifies the second line of address of the recipient. /BulkWireFileLineItems/International/recipientBankAddress1 Specifies the first line of the bank address. /BulkWireFileLineItems/International/recipientBankAddress2 Specifies the second line of the bank address. /BulkWireFileLineItems/International/recipientBankName Specifies the name of the bank. /BulkWireFileLineItems/International/recipientBankcity Specifies the name of the city in which the bank is located. /BulkWireFileLineItems/International/recipientBankstate Specifies the state in which the bank is located. /BulkWireFileLineItems/International/recipientCity Specifies the city in which the bank is located. /BulkWireFileLineItems/International/recipientCountryName Specifies the name of the country in which the recipient resides. /BulkWireFileLineItems/International/recipientName Specifies the name of the recipient. /BulkWireFileLineItems/International/recipientState Specifies the state in which the recipient resides. /BulkWireFileLineItems/International/recipientZipCode Specifies the zip-code. /BulkWireFileLineItems/International/routingNumber Specifies the domestic routing number. /BulkWireFileLineItems/International/swiftCode Specifies the swift code. /BulkWireFileLineItems/International/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. View the Sample Response Code
{
BulkWireFileLineItems: [{
Domestic: [{
amount: "2.34"
bulkWireFileLineItemID: "2"
bulkWireTransferType: "Domestic"
currency: "GBP"
fromAccountNumber: "200929043904310"
internationalRoutingNumber: "456183"
note: "2nd records"
recipientAccountNumber: "1234537"
recipientAddressLine1: "recipientAddressLine12"
recipientAddressLine2: "recipientAddressline22"
recipientBankAddress1: "Bankaddress2"
recipientBankAddress2: "bankaddressline22"
recipientBankName: "recipientBank2"
recipientBankZipCode: "500042"
recipientBankcity: "Hyderabad"
recipientBankstate: "Telangana"
recipientCity: "Hyderabad"
recipientCountryName: "India"
recipientName: "wer"
recipientState: "Telangana"
recipientZipCode: "500081"
routingNumber: "98568"
swiftCode: "abc124"
transactionType: "Business"
}]
International: [{
amount: "1.22"
bulkWireFileLineItemID: "1"
bulkWireTransferType: "International"
currency: "USD"
fromAccountNumber: "200929043904310"
internationalRoutingNumber: "456182"
note: "1st records"
recipientAccountNumber: "1234536"
recipientAddressLine1: "recipientAddressLine11"
recipientAddressLine2: "recipientAddressline21"
recipientBankAddress1: "Bankaddress1"
recipientBankAddress2: "bankaddressline21"
recipientBankName: "recipientBank1"
recipientBankZipCode: "500042"
recipientBankcity: "Hyderabad"
recipientBankstate: "Telangana"
recipientCity: "Hyderabad"
recipientCountryName: "India"
recipientName: "dgf"
recipientState: "Telangana"
recipientZipCode: "500081"
routingNumber: "98567"
swiftCode: "abc123"
transactionType: "Individual"]}
httpStatusCode: 0
opstatus: 0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
createDisputedTransaction
| Description: | This API allows the user to lodge a dispute for any posted transaction. | ||||
| Method: | POST | ||||
| URL: | /services/data/v1/RBObjects/operations/Transactions/createDisputedTransaction | ||||
| Security Level: | Authenticated App User | ||||
| Header Request: | X-Kony-Authorization | ||||
| Body Request: |
Parameters transactionId (Mandatory) Specifies the unique ID of the transaction that is believed to be disputed disputeReason (Mandatory) Specifies the reason for the dispute. The following reasons are supported:
disputeDescription Specifies the description about the nature of the dispute transactionType (Mandatory) Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. transactionsNotes Specifies the additional information about the transaction. amount (Mandatory) Specifies the disputed amount. description Specifies the description displayed to the user while posting the transaction. fromAccountName (Mandatory) Specifies the name of the account from which the amount is transferred. fromAccountNumber (Mandatory) Specifies the account number from which the amount is transferred. fromAccountType Specifies the type of account from which the amount is transferred. toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. transactionDate (Mandatory) Specifies the date on which the transaction occurred. secureMessageId Specifies the unique ID for secure messaging. merchantCity Specifies the city of the merchant to whom the amount was transferred. merchantAddressName Specifies the address of the merchant to whom the amount was transferred. {
"transactionId":"29366",
"disputeReason":"I don't recognize this transaction",
"disputeDescription":"lkjhgf",
"transactionType":"ExternalTransfer",
"transactionsNotes":"",
"amount":"-1.75",
"description":"Transfer To Infinityaccount",
"fromAccountName":"Progress Business Checking",
"fromAccountNumber":"200929090225645",
"fromAccountType":"Checking",
"toAccountName":"Infinityaccount",
"toAccountNumber":"123456",
"transactionDate":"2020-09-29T12:55:08Z",
"secureMessageId":"",
"merchantCity":"",
"merchantAddressName":""
}
|
||||
| Response: | {
"opstatus":0,
"httpStatusCode":0
}
|
||||
| Error Code(s): |
|
||||
| Service Flow: |
|
getPostedDeposits
| Description: | This API allows the user to fetch the deposit of a logged-in user. | ||
| Method: | POST | ||
| URL: | services/data/v1/RBObjects/operations/Transactions/getPostedDeposits | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
None |
||
| Response: |
View the Response Parameters
/Transactions Specifies an array of Transaction JSON Object and the corresponding details. /Transactions/amount Specifies the amount that is to be transferred. /Transactions/amountRecieved Specifies the amount that is recieved. /Transactions/cashAmount Specifies the cash amount. /Transactions/category Specifies the category to which the transaction belongs. /Transactions/checkNumber Specifies the check number for the transaction. /Transactions/checkNumber1 /Transactions/checkNumber2 /Transactions/description Specifies the description of the transaction. /Transactions/fee Specifies the fee charged for the transaction. /Transactions/frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /Transactions/fromAccountBalance Specifies the balance of the account from which the amount gets transferred. /Transactions/hasDepositImage Specifies whether the account has a deposit image. The value is Boolean. /Transactions/isDisputed Specifies whether the transaction is disputed. The value is Boolean. /Transactions/isPayeeDeleted Specifies whether the payee is deleted. The value is Boolean. /Transactions/isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /Transactions/numberOfRecurrences Specifies the number of recurrences for the transaction. /Transactions/payPersonName Specifies the name of the recipient. /Transactions/payeeCurrency Specifies the currency in which the payee has performed the transaction. /Transactions/postedDate Specifies the date on which the deposit was posted. /Transactions/serviceName Specifies the name of the service. /Transactions/statusDescription Specifies the description of the status. /Transactions/toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. /Transactions/toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. /Transactions/toAccountType Specifies the type of account to which the amount is transferred. /Transactions/totalCheckAmount Specifies the total check amount. /Transactions/transactionCurrency Specifies the currency in which the transaction takes place. /Transactions/transactionDate Specifies the date on which the transaction took place. /Transactions/transactionId Specifies the unique ID of the transaction. /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /Transactions/transactionsNotes Specifies the additional notes for a transaction. /Transactions/withdrawlAmount1 Specifies the withdrawal amount /Transactions/withdrawlAmount2 Specifies the withdrawal amount.
View the Sample Response Code
{
Transactions:[{amount: "53.00"
amountRecieved: "0"
cashAmount: "0.00"
category: "Uncategorised"
checkNumber: "9812"
checkNumber1: "Check #"
checkNumber2: "Check #"
description: "Check 9812"
fee: "0.00"
frequencyType: "Once"
fromAccountBalance: "6885.39"
hasDepositImage: "false"
isDisputed: "false"
isPayeeDeleted: "false"
isScheduled: "false"
numberOfRecurrences: "0"
payPersonName: ""
payeeCurrency: "INR"
postedDate: "2020-08-11T05:30:33Z"
serviceName: ""
statusDescription: "Pending"
toAccountName: "Rewards Savings"
toAccountNumber: "200811053028215"
toAccountType: "Savings"
totalCheckAmount: "0.00"
transactionCurrency: "USD"
transactionDate: "2020-08-05T12:00:00Z"
transactionId: "84447"
transactionType: "Deposit"
transactionsNotes: "Insurance refund"
withdrawlAmount1: "0.00"
withdrawlAmount2: "0.00"}
]
"opstatus":0,
"httpStatusCode":0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getPostedTransferAndP2pTransaction
| Description: | This API allows the user to fetch the Person-To-Person transactions of the logged-in user. | ||
| Method: | POST | ||
| URL: | services/data/v1/RBObjects/operations/Transactions/getPostedTransferAndP2pTransactions | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
None |
||
| Response: |
View the Response Parameters
/Transactions Specifies an array of Transaction JSON Object and the corresponding details. /Transactions/amount Specifies the amount that is to be transferred. /Transactions/amountRecieved Specifies the amount that is recieved. /Transactions/cashAmount Specifies the cash amount. /Transactions/category Specifies the category to which the transaction belongs. /Transactions/checkNumber Specifies the check number for the transaction. /Transactions/checkNumber1 /Transactions/checkNumber2 /Transactions/description Specifies the description of the transaction. /Transactions/fee Specifies the fee charged for the transaction. /Transactions/frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /Transactions/fromAccountBalance Specifies the balance of the account from which the amount gets transferred. /Transactions/hasDepositImage Specifies whether the account has a deposit image. The value is Boolean. /Transactions/isDisputed Specifies whether the transaction is disputed. The value is Boolean. /Transactions/isPayeeDeleted Specifies whether the payee is deleted. The value is Boolean. /Transactions/isScheduled Specifies whether the transfer is a scheduled transfer or a normal transfer. /Transactions/numberOfRecurrences Specifies the number of recurrences for the transaction. /Transactions/payPersonName Specifies the name of the recipient. /Transactions/payeeCurrency Specifies the currency in which the payee has performed the transaction. /Transactions/postedDate Specifies the date on which the deposit was posted. /Transactions/serviceName Specifies the name of the service. /Transactions/statusDescription Specifies the description of the status. /Transactions/toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. /Transactions/toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. /Transactions/toAccountType Specifies the type of account to which the amount is transferred. /Transactions/totalCheckAmount Specifies the total check amount. /Transactions/transactionCurrency Specifies the currency in which the transaction takes place. /Transactions/transactionDate Specifies the date on which the transaction took place. /Transactions/transactionId Specifies the unique ID of the transaction. /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /Transactions/transactionsNotes Specifies the additional notes for a transaction. /Transactions/withdrawlAmount1 Specifies the withdrawal amount /Transactions/withdrawlAmount2 Specifies the withdrawal amount. View the Sample Response Code
{
Transactions:[amount: "-5.00"
amountRecieved: "0"
cashAmount: "0.00"
category: "Uncategorised"
checkNumber: "0"
checkNumber1: "Check #"
checkNumber2: "Check #"
description: "Person2PersonTransfer to Judy Blume"
fee: "0.00"
frequencyEndDate: "2020-08-11T12:00:00Z"
frequencyType: "Once"
fromAccountBalance: "6845.39"
fromAccountName: "Rewards Savings"
fromAccountNumber: "200811053028215"
fromAccountType: "Savings"
fromNickName: "My Savings"
hasDepositImage: "false"
isDisputed: "false"
isPayeeDeleted: "false"
isScheduled: "false"
numberOfRecurrences: "0"
payPersonEmail: "judy.blume@gmail.com"
payPersonName: "Judy Blume"
payPersonPhone: "+91-8790146356"
payeeCurrency: "INR"
personId: "3141"
postedDate: "2020-08-11T11:27:58Z"
scheduledDate: "2020-08-11T12:00:00Z"
secondaryEmail: "jblume@gmail.com"
secondoryPhoneNumber: "+91-4567483920"
serviceName: "P2P_CREATE"
statusDescription: "Successful"
totalCheckAmount: "0.00"
transactionCurrency: "USD"
transactionDate: "2020-08-11T11:27:56Z"
transactionId: "92683"
transactionType: "P2P"
transactionsNotes: ""
withdrawlAmount1: "0.00"
withdrawlAmount2: "0.00"
]
"opstatus":0,
"httpStatusCode":0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getPostedUserTransaction
| Description: | This API allows the user to fetch the recent transactions. | ||
| Method: | POST | ||
| URL: | services/data/v1/RBObjects/operations/Transactions/getPostedUserTransaction | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters firstRecordNumber Specifies the starting integer of the set of records. lastRecordNumber Specifies the last integer of the set of records. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. sortBy Specifies the row from where the data must be retreived. The offset value is often used together with the limit. order Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending. searchType Specifies the the type of search such as amount, date, or transaction. searchDescription Specifies the description of the search. searchMinAmount Specifies the minimum amount based on which the transactions must be fetched searchMaxAmount Specifies the maximum amount based on which the transactions must be fetched searchAmount Specifies the amount based on which the transactions must be fetched. searchStartDate Specifies the start date based on which the transactions must be fetched. searchEndDate Specifies the end date based on which the transactions must be fetched. searchDateRange Specifies the range of dates based on which the transactions must be fetched. checkNumber Specifies the check number based on which the transactions must be fetched. fromCheckNumber Specifies the originating check number based on which the transactions must be fetched. toCheckNumber Specifies the ending check number based on which the transactions must be fetched. searchTransactionType Specifies the transaction type based on which the transactions must be fetched. accountNumber Specifies the account number of the user {
"firstRecordNumber":0,
"lastRecordNumber":10,
"isScheduled":0,
"sortBy":"transactionDate",
"order":"desc"
}
|
||
| Response: |
View the Response Parameters
/Transactions Specifies an array of Transaction JSON Object and the corresponding details. /Transactions/amount Specifies the amount that is to be transferred. /Transactions/category Specifies the category to which the transaction belongs. /Transactions/description Specifies the description of the transaction. /Transactions/fee Specifies the fee charged for the transaction. 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). /Transactions/frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /Transactions/fromAccountBalance Specifies the balance of the account from which the amount gets transferred. /Transactions/fromAccountName Specifies the name of the account from which the amount gets transferred. /Transactions/fromAccountNumber Specifies the number of the account from which the amount gets transferred. /Transactions/fromAccountType Specifies the type of the account from which the amount gets transferred. /Transactions/fromNickName Specifies the nick name of the user. /Transactions/hasDepositImage Specifies whether the account has a deposit image. The value is Boolean. /Transactions/isBusinessPayee Specifies whether the payee is a business payee. The value is Boolean. /Transactions/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) /Transactions/numberOfRecurrences Specifies the number of recurrences for the transaction. /Transactions/serviceName Specifies the name of the service. /Transactions/statusDescription Specifies the description of the status. /Transactions/toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. /Transactions/toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. /Transactions/toAccountType Specifies the type of account to which the amount is transferred. /Transactions/transactionCurrency Specifies the currency in which the transaction takes place. /Transactions/transactionDate Specifies the date on which the transaction took place. /Transactions/transactionId Specifies the unique ID of the transaction. /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /Transactions/transactionsNotes Specifies the additional notes for a transaction. View the Sample Response Code
{
Transactions:[{amount: "5.00"
category: "Uncategorised"
description: "Transfer To Business Checking - Fairfield Branch"
fee: "0.00"
frequencyEndDate: "2020-08-11T12:00:00Z"
frequencyType: "Once"
fromAccountBalance: "510847.74"
fromAccountName: "Business Advantage Savings"
fromAccountNumber: "200811053120086"
fromAccountType: "Savings"
fromNickName: "Business Savings"
hasDepositImage: "false"
isBusinessPayee: "1"
isScheduled: "false"
numberOfRecurrences: "0"
scheduledDate: "2020-08-11T12:00:00Z"
serviceName: "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE"
statusDescription: "Successful"
toAccountName: "Pro Business Checking"
toAccountNumber: "200811053120396"
toAccountType: "Checking"
transactionCurrency: "USD"
transactionDate: "2020-08-11T11:40:49Z"
transactionId: "92809"
transactionType: "InternalTransfer"
transactionsNotes: ""}
]
"opstatus":0,
"httpStatusCode":0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getRecentUserTransaction
| Description: | This API allows the user to fetch the recent transactions. | ||
| Method: | POST | ||
| URL: | services/data/v1/RBObjects/operations/Transactions/getRecentUserTransactions | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters firstRecordNumber Specifies the starting integer of the set of records. lastRecordNumber Specifies the last integer of the set of records. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. sortBy Specifies the row from where the data must be retreived. The offset value is often used together with the limit. order Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending. {
"firstRecordNumber":0,
"lastRecordNumber":10,
"isScheduled":0,
"sortBy":"transactionDate",
"order":"desc"
}
|
||
| Response: |
View the Response Parameters
/Transactions Specifies an array of Transaction JSON Object and the corresponding details. /Transactions/amount Specifies the amount that is to be transferred. /Transactions/category Specifies the category to which the transaction belongs. /Transactions/description Specifies the description of the transaction. /Transactions/fee Specifies the fee charged for the transaction. 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). /Transactions/frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /Transactions/fromAccountBalance Specifies the balance of the account from which the amount gets transferred. /Transactions/fromAccountName Specifies the name of the account from which the amount gets transferred. /Transactions/fromAccountNumber Specifies the number of the account from which the amount gets transferred. /Transactions/fromAccountType Specifies the type of the account from which the amount gets transferred. /Transactions/fromNickName Specifies the nick name of the user. /Transactions/hasDepositImage Specifies whether the account has a deposit image. The value is Boolean. /Transactions/isBusinessPayee Specifies whether the payee is a business payee. The value is Boolean. /Transactions/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) /Transactions/numberOfRecurrences Specifies the number of recurrences for the transaction. /Transactions/serviceName Specifies the name of the service. /Transactions/statusDescription Specifies the description of the status. /Transactions/toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. /Transactions/toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. /Transactions/toAccountType Specifies the type of account to which the amount is transferred. /Transactions/transactionCurrency Specifies the currency in which the transaction takes place. /Transactions/transactionDate Specifies the date on which the transaction took place. /Transactions/transactionId Specifies the unique ID of the transaction. /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /Transactions/transactionsNotes Specifies the additional notes for a transaction. View the Sample Response Code
{
Transactions:[{amount: "5.00"
category: "Uncategorised"
description: "Transfer To Business Checking - Fairfield Branch"
fee: "0.00"
frequencyEndDate: "2020-08-11T12:00:00Z"
frequencyType: "Once"
fromAccountBalance: "510847.74"
fromAccountName: "Business Advantage Savings"
fromAccountNumber: "200811053120086"
fromAccountType: "Savings"
fromNickName: "Business Savings"
hasDepositImage: "false"
isBusinessPayee: "1"
isScheduled: "false"
numberOfRecurrences: "0"
scheduledDate: "2020-08-11T12:00:00Z"
serviceName: "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE"
statusDescription: "Successful"
toAccountName: "Pro Business Checking"
toAccountNumber: "200811053120396"
toAccountType: "Checking"
transactionCurrency: "USD"
transactionDate: "2020-08-11T11:40:49Z"
transactionId: "92809"
transactionType: "InternalTransfer"
transactionsNotes: ""}
]
"opstatus":0,
"httpStatusCode":0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
getUserScheduledTransaction
| Description: | This API allows the user to fetch the scheduled user transactions. | ||
| Method: | POST | ||
| URL: | services/data/v1/RBObjects/operations/Transactions/getUserScheduledTransactions | ||
| Security Level: | Authenticated App User | ||
| Header Request: | X-Kony-Authorization | ||
| Body Request: |
Parameters firstRecordNumber Specifies the starting integer of the set of records. lastRecordNumber Specifies the last integer of the set of records. isScheduled (Mandatory) Specifies whether the transfer is a scheduled transfer or a normal transfer. sortBy Specifies the row from where the data must be retreived. The offset value is often used together with the limit. order Specifies the order in which the fetched users must be sorted such as ascending or descending (asc/desc). By default, the value is set to ascending. {
"firstRecordNumber":0,
"lastRecordNumber":10,
"isScheduled":1,
"sortBy":"scheduledDate",
"order":"desc"
}
|
||
| Response: |
View the Response Parameters
/Transactions Specifies an array of Transaction JSON Object and the corresponding details. /Transactions/amount Specifies the amount that is to be transferred. /Transactions/category Specifies the category to which the transaction belongs. /Transactions/description Specifies the description of the transaction. /Transactions/fee Specifies the fee charged for the transaction. 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). /Transactions/frequencyType Specifies the frequency at which the payment transfers must be made. The transfers can be made on a daily, weekly, or monthly basis. /Transactions/fromAccountBalance Specifies the balance of the account from which the amount gets transferred. /Transactions/fromAccountName Specifies the name of the account from which the amount gets transferred. /Transactions/fromAccountNumber Specifies the number of the account from which the amount gets transferred. /Transactions/fromAccountType Specifies the type of the account from which the amount gets transferred. /Transactions/fromNickName Specifies the nick name of the user. /Transactions/hasDepositImage Specifies whether the account has a deposit image. The value is Boolean. /Transactions/isBusinessPayee Specifies whether the payee is a business payee. The value is Boolean. /Transactions/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) /Transactions/numberOfRecurrences Specifies the number of recurrences for the transaction. /Transactions/serviceName Specifies the name of the service. /Transactions/statusDescription Specifies the description of the status. /Transactions/toAccountName (Mandatory) Specifies the name of the account to which the amount is transferred. /Transactions/toAccountNumber (Mandatory) Specifies the account number to which the amount is transferred. /Transactions/toAccountType Specifies the type of account to which the amount is transferred. /Transactions/transactionCurrency Specifies the currency in which the transaction takes place. /Transactions/transactionDate Specifies the date on which the transaction took place. /Transactions/transactionId Specifies the unique ID of the transaction. /Transactions/transactionType Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer. /Transactions/transactionsNotes Specifies the additional notes for a transaction. View the Sample Response Code
{
Transactions:[amount: "1.00"
category: "Uncategorised"
description: "Transfer To My Checking"
fee: "0.00"
frequencyType: "Once"
fromAccountBalance: "6840.39"
fromAccountName: "Rewards Savings"
fromAccountNumber: "200811053028215"
fromAccountType: "Savings"
fromNickName: "My Savings"
hasDepositImage: "false"
isBusinessPayee: "0"
isScheduled: "true"
numberOfRecurrences: "0"
scheduledDate: "2020-10-01T12:00:00Z"
serviceName: "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE"
statusDescription: "Pending"
toAccountName: "Core Checking"
toAccountNumber: "200811053028239"
toAccountType: "Checking"
transactionCurrency: "USD"
transactionDate: "2020-09-30T10:30:46Z"
transactionId: "291647"
transactionType: "InternalTransfer"
transactionsNotes: ""
]
"opstatus":0,
"httpStatusCode":0
}
|
||
| Error Code(s): |
|
||
| Service Flow: |
|
Add Bookmark
save your best linksView Bookmarks
Visit your best links
BACK
Are you sure you want to log-off?