Payment and Transfer
The following APIs are common to both Retail Banking and SME Banking APIs.
| 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 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 bank account with in the country. | 2020.07 |
| InterBankFundTransferEdit | 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 |
| getTransfers | 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 |
| Create | This API allows the user to create a one time transfer. | 2020.10 |
| getPayeeName | This API allows the user to fetch the name of the beneficiary. | 2020.10 |
| getPayeeList | This API retrieves the list of beneficiary details. | 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 |
| getInstructions | 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 |
| getBankDetailsFromBicCode | This API retrieves the payee bank name from core, when user keys in payee bank BIC. | 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 |
| getTransactionStatementsByYear | Retrieves the transaction statements from the backend. | 2020.10 |
| downloadStatements | Downloads the account statements. | 2020.10 |
| retrieveAttachments | Retrieves the documents stored in the database or Document Management System (DMS) based on the referenceId. This API is used in the Payments and Transfers Flow and in Accounts Transaction flow. | 2021.01 |
| createPayee | This API creates payee in the UTF/Euro flow. | 2021.07 |
| editPayee | This API edits the list of payees in the UTF/Euro flow. | 2021.07 |
| getPayees | This API fetches the list of payees in the UTF/Euro flow. | 2021.07 |
| deletePayee | This API deletes payees in the UTF/Euro flow. | 2021.07 |
| Create(FX rate & Credit Value) | This API retrieves the charges, FX rate & credit value date for the transfer & display on screen. | 2021.10 |
| Create(Recurring Transfer Request) | This API submits the adhoc transfer/ recurring transfer request. | 2021.10 |
| createCreditCardTransfer | This API makes a transfer to a credit card. | 2021.10 |
| getPurposeCodes | This API retrieves all the possible purpose codes and clearing Identifier codes for Transfers. | 2024.04 |
| Object Data Models | This Object Data Model describes the parameter name and other attribute details for P2P Payee. |
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: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/TransferToOwnAccounts |
| 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 (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS or DBX DB. charges Specifies the charges incurred for the transaction . exchangeRate Specifies the rate of exchange to which the transaction currency is converted in base currency. totalAmount Specifies the total debit amount for a transaction. referenceID Specifies the ID generated for the reference. userID Specifies the customer ID. Request Code for One Time Transfer {
"amount": "50.00",
"transactionId": "PI211050MDK7MT83",
"frequencyType": "Once",
"fromAccountNumber": "131644",
"iban": "",
"isScheduled": "0",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyEndDate": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"numberOfRecurrences": "",
"toAccountNumber": "131652",
"paymentType": "",
"paidBy": "",
"swiftCode": "",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"beneficiaryName": "Current Account",
"beneficiaryNickname": "",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "EUR",
"toAccountCurrency": "USD",
"ExternalAccountNumber": "131652",
"uploadedattachments": "",
"clearingCode": "",
"intermediaryBicCode": "",
"e2eReference": "",
"charges": "[{"
chargeType ":"
TRANSACTIONFEE ","
chargeAmount ":5,"
chargeName ":"
Transaction Fee ","
chargeCurrency ":"
GBP ","
chargeAccountCurrencyAmount ":"
5.85 "}]",
"exchangeRate": "1.1193",
"totalAmount": "50.52",
"creditValueDate": "2021-04-15T00:00:00Z",
"transactionAmount": "50.00",
"userId": "",
"deletedDocuments": "",
"createWithPaymentId": "true"
}
Request Code for Recurring Transfer {
"amount": "1.00",
"transactionId": "",
"frequencyType": "Daily",
"fromAccountNumber": "118567",
"iban": "",
"isScheduled": "1",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyEndDate": "2021-04-22T00:00:00.000Z",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"numberOfRecurrences": "",
"toAccountNumber": "118516",
"paymentType": "",
"paidBy": "",
"swiftCode": "",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"beneficiaryName": "Savings Account",
"beneficiaryNickname": "",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": "USD",
"ExternalAccountNumber": "118516",
"uploadedattachments": "",
"clearingCode": "",
"intermediaryBicCode": "",
"e2eReference": "",
"charges": "",
"exchangeRate": "",
"totalAmount": "",
"creditValueDate": "",
"transactionAmount": "1.00",
"userId": "",
"deletedDocuments": "",
"createWithPaymentId": "true"
}
|
| 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. toAccountCurrency Specifies the currency of account to which the amount must be credited. 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. serviceCharge Specifies the service charge for the current transaction. transactionAmount Specifies the current transaction amount . paidBy specifies charges paid person name. swiftCode specifies the unique swift transaction code. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS or DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS or DBX DB. Response Sample Code for One Time Transfer {
"referenceId": "PI211050MDK7MT83",
"opstatus": 0,
"httpStatusCode": 0,
"status": "success",
"amount": "0",
"charges": "[{"
chargeType ":"
TRANSACTIONFEE ","
chargeAmount ":5,"
chargeName ":"
Transaction Fee ","
chargeCurrency ":"
GBP ","
chargeAccountCurrencyAmount ":"
5.85 "}]",
"exchangeRate": "1.1193",
"totalAmount": "50.52",
"creditValueDate": "2021-04-15T00:00:00Z",
"messageDetails": "[{"
id ":"
PI - SIM.OFF.FX.INVOLVE1 ","
message ":"
Message: The rate calculated is a reference rate and not actual rate "},{"
id ":"
PI - SIM.OFF.FX.INVOLVE2 ","
message ":"
Message: Amount shown are notional "}]"
}
Response Sample Code for Recurring Transfer {
"referenceId": "20760",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "1",
"frequencyEndDate": "2021-04-22T00:00:00Z",
"frequencyType": "Daily",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118567",
"isScheduled": "1",
"scheduledDate": "2021-04-15T00:00:00Z",
"toAccountCurrency": "USD",
"toAccountNumber": "118516",
"transactionCurrency": "USD",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"overrides": "",
"exchangeRate": "",
"totalAmount": "",
"serviceCharge": "0.0",
"transactionAmount": "1.0",
"paidBy": "",
"swiftCode": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
TransferToOwnAccountsEdit
| Description: | This API is used to edit the transaction that has occurred between your accounts. |
| Method: | POST |
| URL: | {base_url}services/data/v1/TransactionObjects/operations/Transaction/TransferToOwnAccountsEdit |
| 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. uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS or DBX DB. View the Request Sample Code
{
"amount": "1.11",
"description": "Transfer To Current Account",
"frequencyEndDate": "2020-05-20T10:14:18.724Z",
"frequencyStartDate": "2020-04-20T10:14:18.724Z",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:14:18.724Z",
"toAccountNumber": "114685",
"transactionDate": "04/20/2020",
"transactionId": "114677.1",
"transactionsNotes": "TestRecurringReferenceTIMATIMA",
"transactionType": "InternalTransfer",
"transactionCurrency": "",
"payeeCurrency": "USD",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"statusDescription": "-Active",
"pendingApproval": false,
"deletedDocuments": "",
"uploadedattachments": ""
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the transfer. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS or DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS or DBX DB. {
"referenceId": "114677.1",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "1.11",
"frequencyEndDate": "2020-05-20T10:14:18Z",
"frequencyType": "Daily",
"fromAccountCurrency": "USD",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:14:18Z",
"toAccountNumber": "114685",
"transactionCurrency": "USD",
"transactionsNotes": "TestRecurringReferenceTIMATIMA",
"transactionType": "InternalTransfer",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"transactionAmount": "1.11",
"paidBy": "",
"swiftCode": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
TransferToOwnAccountsDelete
| Description: | This API is used to delete the transaction that has occurred between your accounts. |
| Method: | DELETE |
| URL: | {base_url/services/data/v1/TransactionObjects/operations/Transaction/TransferToOwnAccountsDelete |
| 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": "PI2010810RN7XGYX",
"frequencyType": "Once"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the transfer. {
"referenceId": "PI2010810RN7XGYX",
"message": "Success! Your transaction has been completed",
"status": "Sent",
"httpStatusCode": 0,
"opstatus": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
IntraBankAccFundTransfer
| Description: | This API is used to perform an external transaction within your bank. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/IntraBankAccFundTransfer |
| 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 (Mandatory) Specifies the details of the uploaded attachments such as PDFs. charges Specifies the charges incurred for the transaction . exchangeRate Specifies the rate of exchange to which the transaction currency is converted in base currency. totalAmount Specifies the total debit amount for a transaction. referenceID Specifies the ID generated for the reference. userID Specifies the customer ID. Payload for One Time Transfer(Transfer amount to beneficiary having account in same bank)
{
"ExternalAccountNumber": "118567",
"amount": "1.00",
"beneficiaryAddressLine1": "Address1",
"beneficiaryAddressLine2": "Address2",
"beneficiaryCity": "Chennai",
"beneficiarycountry": "India",
"beneficiaryEmail": "abc@temenos.com",
"beneficiaryName": "Max",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "123456",
"createWithPaymentId": "true",
"deletedDocuments": "",
"frequencyEndDate": "",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118664",
"iban": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "",
"paymentType": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"swiftCode": "",
"toAccountCurrency": "USD",
"toAccountNumber": "118567",
"transactionCurrency": "USD",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
Payload for Recurring Transfer(Transfer amount to beneficiary having account in same bank)
{
"ExternalAccountNumber": "118656",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "Helen",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"frequencyEndDate": "2021-04-23T00:00:00.000Z",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Daily",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "118656",
"iban": "",
"isScheduled": "1",
"numberOfRecurrences": "",
"paidBy": "",
"paymentType": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"swiftCode": "",
"toAccountCurrency": "EUR",
"toAccountNumber": "118656",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
Payload for Recurring Transfer(Transfer amount to beneficiary having account in same bank)
{
"ExternalAccountNumber": "118656",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "Helen",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"frequencyEndDate": "2021-04-23T00:00:00.000Z",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Daily",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "118656",
"iban": "",
"isScheduled": "1",
"numberOfRecurrences": "",
"paidBy": "",
"paymentType": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"swiftCode": "",
"toAccountCurrency": "EUR",
"toAccountNumber": "118656",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the transfer. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. serviceCharge Specifies the charges for the service. transactionAmount Specifies the amount for the transaction. paidBy Specifies the feed paid by for the transaction. swiftCode Specifies the bank identifier code that is valid throughout the country. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS/DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS/ DBX DB. Response for One Time Transfer(Transfer amount to beneficiary having account in same bank)
{
"referenceId": "PI21105071VF8RMR",
"opstatus": 0,
"httpStatusCode": 0,
"status": "success",
"amount": "0",
"charges": "",
"totalAmount": "1"
}
Response for Recurring Transfer(Transfer amount to beneficiary having account in same bank)
{
"opstatus": 0,
"httpStatusCode": 0,
"amount": "1",
"frequencyEndDate": "2021-04-23T00:00:00Z",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "118656",
"isScheduled": "1",
"scheduledDate": "2021-04-15T00:00:00Z",
"toAccountCurrency": "EUR",
"toAccountNumber": "118656",
"transactionCurrency": "EUR",
"transactionType": "ExternalTransfer",
"paidBy": "",
"swiftCode": "",
"beneficiaryAddressLine2": "",
"beneficiaryZipcode": "",
"beneficiaryPhone": "",
"beneficiaryEmail": "",
"beneficiaryState": "",
"beneficiaryAddressLine1": "",
"beneficiaryCity": "",
"beneficiarycountry": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
IntraBankAccFundTransferEdit
| Description: | This API is used to edit the external transaction that has occurred within your bank. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/IntraBankAccFundTransferEdit |
| 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. 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. uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS or DBX DB. View the Request Sample Code
{
"amount": "22.22",
"description": "Transfer To Rolf",
"ExternalAccountNumber": "103926",
"frequencyEndDate": "2020-06-24T10:23:28.523Z",
"frequencyStartDate": "2020-04-20T10:23:28.523Z",
"frequencyType": "Weekly",
"fromAccountName": "Current Account",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:23:28.523Z",
"toAccountName": "Rolf",
"toAccountNumber": "103926",
"transactionDate": "04/20/2020",
"transactionId": "114677.5",
"transactionsNotes": "SambeBankRecurringEditSBRETIMA",
"transactionType": "ExternalTransfer",
"transactionCurrency": "",
"payeeCurrency": "EUR",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Rolf",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false,
"deletedDocuments": "",
"uploadedattachments": ""
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the edited transaction. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS/DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS/ DBX DB. {
"referenceId": "114677.5",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "22.22",
"frequencyEndDate": "2020-06-24T10:23:28Z",
"frequencyType": "Weekly",
"fromAccountCurrency": "USD",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:23:28Z",
"toAccountNumber": "103926",
"transactionCurrency": "EUR",
"transactionsNotes": "SambeBankRecurringEditSBRETIMA",
"transactionType": "ExternalTransfer",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"transactionAmount": "22.22",
"paidBy": "Both",
"swiftCode": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | DBX BD |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
IntraBankAccFundTransferDelete
| Description: | This API is used to delete the transaction that has occurred between your accounts. |
| Method: | DELETE |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/IntraBankAccFundTransferDelete |
| 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. frequencyType (Mandatory) Specifies the type of frequency. {
"transactionId": "PI201080VY2Q5WMB",
"frequencyType": "Once"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the deleted transaction. message Specifies the if the transaction is success or not. status Specifies the status of the transaction. {
"referenceId": "PI201080VY2Q5WMB",
"message": "Success! Your transaction has been completed",
"status": "Sent",
"httpStatusCode": 0,
"opstatus": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
InterBankAccFundTransfer
| Description: | This API is used to perform a transaction with any other bank account with in the country. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InterBankAccFundTransfer |
| 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 . uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS or DBX DB. charges Specifies the charges incurred for the transaction . exchangeRate Specifies the rate of exchange to which the transaction currency is converted in base currency. totalAmount Specifies the total debit amount for a transaction. referenceID Specifies the ID generated for the reference. userID Specifies the customer ID. paidBy Specifies the account by which the fees is paid. beneficiaryName Specifies the name of the beneficiary to which the amount is credited. Payload for One Time Transfer
{
"ExternalAccountNumber": "GB04BARC20474473160944",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryBankName": "BARCLAYS BANK BRANCH B22, GB",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "DomOne",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"clearingCode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"e2eReference": "",
"frequencyEndDate": "2023-04-18T00:00:00.000Z",
"frequencyStartDate": "2023-04-18T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "128902",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "Instant",
"scheduledDate": "2023-04-18T00:00:00.000Z",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"toAccountCurrency": "EUR",
"toAccountNumber": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"localInstrumentProprietary": "INST",
"purposeCode": "BKFE - Bank Loan Fees",
"serviceLevelProprietary": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
"verifyPayee": "true"
}
Payload for Recurring Transfer
{
"ExternalAccountNumber": "GB04BARC20474473160944",
"amount": "1.00",
"beneficiaryAddressLine1": "Adr1",
"beneficiaryAddressLine2": "Adr2",
"beneficiaryBankName": "BARCLAYS BANK BRANCH B22, GB",
"beneficiaryCity": "Texas",
"beneficiarycountry": "Usa",
"beneficiaryEmail": "",
"beneficiaryName": "Sujji",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "500056",
"clearingCode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"e2eReference": "",
"frequencyEndDate": "2021-04-29T00:00:00.000Z",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Daily",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118637",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "1",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "INSTPAY",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"toAccountCurrency": "EUR",
"toAccountNumber": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
|
| 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 the additional charges levied for performing the transaction. totalAmount Specifies the total amount involved in the transaction. serviceCharge Specifies the charges for the service. charges Specifies an array of charges and the corresponding details. transactionAmount Specifies the transaction amount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS or DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS or DBX DB. Response for One Time Transfer
{
"referenceId": "PI231080YD8Z03Q6",
"opstatus": 0,
"httpStatusCode": 0,
"status": "success",
"amount": "0",
"charges": "",
"totalAmount": "1"
"payeeVerification": "Success"
}
Response for Recurring Transfer
{
"opstatus": 0,
"httpStatusCode": 0,
"amount": "1",
"frequencyEndDate": "2021-04-29T00:00:00Z",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118637",
"isScheduled": "1",
"scheduledDate": "2021-04-15T00:00:00Z",
"toAccountNumber": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"transactionType": "ExternalTransfer",
"iban": "",
"swiftCode": "BARCGB22",
"beneficiaryName": "Sujji",
"paidBy": "SHA",
"paymentType": "INSTPAY",
"beneficiaryAddressLine1": "Adr1",
"beneficiaryCity": "Texas",
"beneficiarycountry": "Usa",
"intermediaryBicCode": "",
"clearingCode": "",
"e2eReference": "",
"beneficiaryBankName": "BARCLAYS BANK BRANCH B22, GB",
"beneficiaryAddressLine2": "Adr2",
"beneficiaryZipcode": "500056",
"beneficiaryPhone": "",
"beneficiaryEmail": "",
"beneficiaryState": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
InterBankFundTransferEdit
| Description: | This API is used to edit the transaction that has occurred with any other local bank account. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InterBankFundTransferEdit |
| 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. 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. uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS or DBX DB. View the Request Sample Code
{
"amount": "23.23",
"description": "Transfer To Interbank",
"frequencyEndDate": "2020-08-12T09:53:50.986Z",
"frequencyStartDate": "2020-04-22T09:53:50.986Z",
"frequencyType": "Weekly",
"fromAccountName": "Current Account",
"fromAccountNumber": "114658",
"isScheduled": "true",
"scheduledDate": "2020-04-22T09:53:50.986Z",
"toAccountName": "Interbank",
"toAccountNumber": "GB04BARC20474473160944",
"transactionDate": "04/22/2020",
"transactionId": "114658.1",
"transactionsNotes": "InterBankRecurringTransferTBRI",
"transactionType": "ExternalTransfer",
"IBAN": "GB04BARC20474473160944",
"transactionCurrency": "",
"payeeCurrency": "EUR",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Interbank",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false,
"deletedDocuments": "",
"uploadedattachments": ""
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the edited transaction. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS or DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS or DBX DB. {
"referenceId": "114658.1",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "23.23",
"frequencyEndDate": "2020-08-12T09:53:50Z",
"frequencyType": "Weekly",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "114658",
"isScheduled": "true",
"scheduledDate": "2020-04-22T09:53:50Z",
"toAccountNumber": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"transactionsNotes": "InterBankRecurringTransferTBRI",
"transactionType": "ExternalTransfer",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"beneficiaryName": "Interbank",
"paidBy": "SHA",
"paymentType": "",
"transactionAmount": "23.23"
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
InterBankFundTransferDelete
| Description: | This API is used to delete the transaction that has occurred with any other local bank account. |
| Method: | DELETE |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InterBankFundTransferDelete |
| 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": "PI201080S2X4CQ72",
"frequencyType": "Once"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the deleted transaction. {
"referenceId": "PI201080S2X4CQ72",
"message": "Success! Your transaction has been completed",
"status": "Sent",
"httpStatusCode": 0,
"opstatus": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate SRMS Payment - {base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
InternationalAccFundTransfer
| Description: | This API is used to edit the international transaction. |
| Method: | Custom Verb (InternationalFundTransferEdit) |
| URL: | {base_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. 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. uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS/DBX DB on successful transaction edit. Request Sample Code for One Time Transfer
{
"ExternalAccountNumber": "116823",
"amount": "6.00",
"beneficiaryAddressLine1": "Bengaluru ",
"beneficiaryAddressLine2": "Bangalore",
"beneficiaryBankName": "DEMO BIC FOR MODEL BANK, GB",
"beneficiaryCity": "India",
"beneficiarycountry": "India",
"beneficiaryEmail": "",
"beneficiaryName": "Temenos",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "431256",
"clearingCode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"frequencyEndDate": "",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "131644",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "DEMOGBPX",
"toAccountCurrency": "EUR",
"toAccountNumber": "116823",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
"verifyPayee": "true"
}
Request Sample Code for Recurring Transfer
{
"ExternalAccountNumber": "09876",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryBankName": "BARCLAYS BANK BRANCH B22, GB",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "iNTRENATINAL",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"clearingCode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"frequencyEndDate": "2021-04-21T00:00:00.000Z",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Daily",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118664",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "1",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"toAccountCurrency": "EUR",
"toAccountNumber": "09876",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the edited transaction. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS/DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS/ DBX DB. Response Sample Code for One Time Transfer
{
"referenceId": "PI211050BG6CMWRZ",
"opstatus": 0,
"httpStatusCode": 0,
"status": "success",
"amount": "0",
"charges": "[{"
chargeType ":"
TRANSACTIONFEE ","
chargeAmount ":5,"
chargeName ":"
Transaction Fee ","
chargeCurrency ":"
GBP ","
chargeAccountCurrencyAmount ":"
5.85 "}]",
"totalAmount": "11.85",
"creditValueDate": "2021-04-19T00:00:00Z"
"payeeVerification": "Success"
}
Response Sample Code for Recurring Transfer
{
"opstatus": 0,
"httpStatusCode": 0,
"amount": "1",
"frequencyEndDate": "2021-04-21T00:00:00Z",
"fromAccountCurrency": "USD",
"fromAccountNumber": "118664",
"isScheduled": "1",
"scheduledDate": "2021-04-15T00:00:00Z",
"toAccountNumber": "09876",
"transactionCurrency": "EUR",
"transactionType": "ExternalTransfer",
"iban": "",
"swiftCode": "BARCGB22",
"beneficiaryName": "iNTRENATINAL",
"paidBy": "SHA",
"paymentType": "",
"beneficiaryAddressLine1": "",
"beneficiaryCity": "",
"beneficiarycountry": "",
"intermediaryBicCode": "",
"beneficiaryAddressLine2": "",
"beneficiaryZipcode": "",
"beneficiaryPhone": "",
"beneficiaryEmail": "",
"beneficiaryState": ""
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact or SRMS |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate SRMS Payment - {base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
Transact SRMS Payment
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | requestIn.e2eReference | NA |
| clearingCode | clearingCode | requestIn.clearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | requestIn.intermediaryBICCode | NA |
| NA | submitOrder | requestIn.submitOrder | NA |
| From Account | fromAccountNumber | requestIn.fromAccountNumber | NA |
| To Account | toAccountNumber | requestIn.toAccountNumber | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | requestIn.fromAccountCurrency / requestIn.transactionCurrency(INATIONAL) | NA |
| Amount | amount | requestIn.amount | NA |
| Transfer / Payment Reference | transactionsNotes | requestIn.transactionsNotes | NA |
| Frequency | frequencyType | requestIn.frequencyType | NA |
| Send On | scheduledDate | requestIn.scheduledDate | NA |
| Account Number / IBAN | ExternalAccountNumber | requestIn.ExternalAccountNumber | NA |
| SWIFT / BIC | swiftCode | requestIn.swiftCode | NA |
| Fees Paid By | paidBy | requestIn.paidBy | NA |
| Beneficiary Nickname | beneficiaryName | requestIn.beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | requestIn.uploadedattachments | NA |
| transactionId(Request) | transactionId(Request) | requestIn.transactionId(Request) | NA |
| Reference number(Response) | referenceId(Response) | requestIn.referenceId(Response) | NA |
| Total debit | totalAmount | requestIn.totalAmount | NA |
| Exchange Rate | exchangeRate | requestIn.exchangeRate | NA |
| NA | Overrides(Sepa Cut off Time) | requestIn.Overrides | NA |
| Charges Breakdown | charges | requestIn.charges | NA |
| NA | userId | requestIn.userId | NA |
| NA | validate | requestIn.validate | NA |
| NA | transactionType | requestIn.transactionType | NA |
| NA | beneficiaryAddressLine1 | requestIn.beneficiaryAddressLine1 | NA |
| NA | beneficiaryAddressLine2 | requestIn.beneficiaryAddressLine2 | NA |
| NA | beneficiaryBankName | requestIn.beneficiaryBankName | NA |
| NA | beneficiaryCity | requestIn.beneficiaryCity | NA |
| NA | beneficiarycountry | requestIn.beneficiarycountry | NA |
| NA | beneficiaryEmail | requestIn.beneficiaryEmail | NA |
| NA | beneficiaryNickname | requestIn.beneficiaryNickname | NA |
| NA | beneficiaryPhone | requestIn.beneficiaryPhone | NA |
| NA | beneficiaryZipcode | requestIn.beneficiaryZipcode | NA |
| NA | createWithPaymentId | requestIn.createWithPaymentId | NA |
| NA | deletedDocuments | requestIn.deletedDocuments | NA |
| NA | frequencyEndDate | requestIn.frequencyEndDate | NA |
| NA | beneficiaryState | requestIn.beneficiaryState | NA |
| NA | frequencyStartDate | requestIn.frequencyStartDate | NA |
| NA | iban | requestIn.iban | NA |
| NA | serviceName | requestIn.serviceName | NA |
| NA | toAccountCurrency | requestIn.toAccountCurrency | NA |
| NA | numberOfRecurrences | requestIn.numberOfRecurrences | NA |
| NA | isScheduled | requestIn.isScheduled | NA |
| NA | paymentType | requestIn.paymentType | NA |
| bank Name | NA | requestIn.bank Name | NA |
| addressLine1 | NA | requestIn.addressLine1 | NA |
| countryName | NA | requestIn.countryName | NA |
InternationalFundTransferEdit
| Description: | This API is used to edit the international transaction. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InternationalFundTransferEdit |
| 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. 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. uploadedattachments (Mandatory) Specifies the uploaded attachments in an encoded format where a comma separates the string of filename, file type and file content that is to be uploaded to DMS/DBX DB on successful transaction edit. View the Request Sample Code
{
"amount": "24.24",
"description": "Transfer To Internationalbank",
"ExternalAccountNumber": "12345678",
"frequencyEndDate": "2020-08-19T10:07:41.775Z",
"frequencyStartDate": "2020-04-20T10:07:41.775Z",
"frequencyType": "Weekly",
"fromAccountName": "Current Account",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:07:41.775Z",
"toAccountName": "Internationalbank",
"toAccountNumber": "12345678",
"transactionDate": "04/20/2020",
"transactionId": "114677.6",
"transactionsNotes": "InternationalRecurringTransferTIMA",
"transactionType": "ExternalTransfer",
"transactionCurrency": "",
"payeeCurrency": "EUR",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Internationalbank",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false,
"deletedDocuments": "",
"uploadedattachments": ""
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the edited transaction. status Specifies the status of the transaction. message Specifies the status message. amount Specifies the amount involved in the transaction. 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) toAccountCurrency Specifies the currency of the account to which the amount must be credited. 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. serviceName Specifies the name of the service. charges Specifies the additional charges levied for performing the transaction. totalAmount Specifies the total mount involved in the transaction. successfulUploads Specifies an array of documents that are uploaded successfully to the DMS/DBX DB. failedUploads Specifies and array of documents that failed to be uploaded to the DMS/ DBX DB. {
"referenceId": "114677.6",
"opstatus": 0,
"httpStatusCode": 0,
"status": "Sent",
"message": "Success! Your transaction has been completed",
"amount": "24.24",
"frequencyEndDate": "2020-08-19T10:07:41Z",
"frequencyType": "Weekly",
"fromAccountCurrency": "USD",
"fromAccountNumber": "114677",
"isScheduled": "true",
"scheduledDate": "2020-04-20T10:07:41Z",
"toAccountNumber": "12345678",
"transactionCurrency": "EUR",
"transactionsNotes": "InternationalRecurringTransferTIMA",
"transactionType": "ExternalTransfer",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"beneficiaryName": "Internationalbank",
"paidBy": "SHA",
"paymentType": "",
"transactionAmount": "24.24"
}
|
| Error Code(s): |
|
| Enterprise Provider: | DBX BD |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
InternationalFundTransferDelete
| Description: | This API is used to delete the international transaction. |
| Method: | DELETE |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InternationalFundTransferDelete |
| 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": "PI201080S2X4CW3P",
"frequencyType": "Once"
}
|
| Response: |
Parameters referenceId Specifies the unique ID of the deleted transaction. {
"referenceId": "PI201080S2X4CW3P",
"message": "Success! Your transaction has been completed",
"status": "Sent",
"httpStatusCode": 0,
"opstatus": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
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. accountNumber Specifies the external account number. beneficiaryName Specifies the name of the beneficiary. swiftCode Specifies the swift code. IBAN Specifies the International Bank Account Number. 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: | {base_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. accountNumber Specifies the account number of the external account. beneficiaryName Specifies the name of the beneficiary to whom the amount is credited. createdOn Specifies the date on which the external account was created. Id Specifies the ID of the external account. beneficiaryId Specifies the ID of the beneficiary to whom the amount is credited. isInternationalAccount Specifies whether the account is an international account. isSameBankAccount Specifies whether the external account belongs to the same bank as the debtor. isVerified Specifies whether the account is a verified account. nickName Specifies the nick name of the external account holder. 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 . |
getTransfers
| 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: | {base_url}/services/data/v1/Transfers/operations/OneTimeTransfer/getTransfers |
| Security Level: | Authenticated App Users |
| Header Request: |
|
| Body Request: | {
"transactionPeriod":1,
"lastRecordNumber":1000,
"firstRecordNumber":0
}
|
| 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 Specifies 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 transaction 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
fileName Specifies the name of the file. fileID Specifies the name of the file. Click here to see sample response code |
| Error Code(s): |
|
| Enterprise Provider: | Transact or Service Request Microservice |
| Enterprise API: |
{base_url}96666/v2.1.0/order/paymentOrders/?debitAccountId=$debitAccountId&page_start=$firstRecordNumber&page_size=$lastRecordNumber&executionDateGreaterThan=$paymentExecutionDateLE&bulkReference=$bulkReference |
Field Mapping
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| NA | NA | NA | debitAccountId |
| NA | NA | NA | firstRecordNumber |
| NA | NA | NA | lastRecordNumber |
| NA | NA | NA | bulkReference |
| NA | NA | NA | paymentExecutionDateLE |
| NA | NA | NA | chargeBearer |
| NA | NA | NA | amount |
| NA | NA | NA | systemId |
| NA | NA | NA | fromAccountNumber |
| NA | NA | NA | transactionCurrency |
| NA | NA | NA | fromAccountName |
| NA | NA | NA | endToEndReference |
| NA | NA | NA | scheduledDate |
| NA | NA | NA | fromAccountIBAN |
| NA | NA | NA | transactionId |
| NA | NA | NA | transactionType |
| NA | NA | NA | paymentCurrencyId |
| NA | NA | NA | toAccountName |
| NA | NA | NA | fromAccountCurrency |
| NA | NA | NA | ExternalAccountNumber |
| NA | NA | NA | orderingCustomerId |
| NA | NA | NA | toAccountNumber |
| NA | NA | NA | frequencyType |
| NA | NA | NA | paymentStatus |
| NA | NA | NA | serviceName |
| NA | NA | NA | isScheduled |
| NA | NA | NA | paidby |
Create
| Description: | This API allows the user to create a one time transfer. |
| Method: | Post |
| URL: | {base_url}/services/data/v1/Transfers/operations/OneTimeTransfer/Create |
| 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. Inter Bank Scenario Request
{
"ExternalAccountNumber": "NL03ABNA1979747032",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryBankName": "ABN Netherland, NL",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "asdasda",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"clearingCode": "",
"createWithPaymentId": "true",
"deletedDocuments": "",
"e2eReference": "EEE21112",
"frequencyEndDate": "2023-04-18T00:00:00.000Z",
"frequencyStartDate": "2023-04-18T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "131938",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "Instant",
"scheduledDate": "2023-04-18T00:00:00.000Z",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "ABNANL2A",
"toAccountCurrency": "USD",
"toAccountNumber": "NL03ABNA1979747032",
"transactionCurrency": "USD",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "RRR1",
"uploadedattachments": "",
"userId": "",
"clearingIdentifierCode":"ATBLZ",
"validate": "true"
"verifyPayee": "true"
}
International Scenario Request
{
"ExternalAccountNumber": "1233444",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryBankName": "ABN Netherland, NL",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "asdasda",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"clearingCode": "111111",
"createWithPaymentId": "true",
"deletedDocuments": "",
"e2eReference": "III1",
"frequencyEndDate": "2023-04-18T00:00:00.000Z",
"frequencyStartDate": "2023-04-18T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "USD",
"fromAccountNumber": "135868",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "",
"scheduledDate": "2023-04-18T00:00:00.000Z",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "BARCGB22",
"toAccountCurrency": "USD",
"toAccountNumber": "1233444",
"transactionCurrency": "USD",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "RRR1",
"uploadedattachments": "",
"userId": "",
"clearingIdentifierCode":"ATBLZ",
"validate": "true",
"streetName":"qwertyuiosdfghj dfghjk dfghm,xcvbnmwerfgthjk defrgthjk",
"townName":"townganga",
"countryName":"india",
"purposeCode":""
}
|
| Response: |
Inter Bank Scenario Response
{
"beneficiaryZipcode": "",
"isScheduled": "0",
"serviceCharge": "0.0",
"exchangeRate": "0.9861",
"legalEntityId": "GB0010001",
"beneficiaryBankName": "BARCLAYS BANK BRANCH B22, GB",
"beneficiaryName": "",
"beneficiarycountry": "",
"payeeVerificationStatus": "Success",
"townName": "",
"beneficiaryState": "",
"transactionCurrency": "USD",
"transactionId": "291",
"quoteCurrency": "EUR",
"totalAmount": "2.03",
"companyId": "7139227202_190347",
"charges": "",
"opstatus": 0,
"countryName": "",
"frequencyTypeId": "Once",
"status": "Sent",
"httpStatusCode": 0,
"frequencyEndDate": "2023-04-18T00:00:00Z",
"fromAccountNumber": "122998",
"processingDate": "2023-04-18T00:00:00Z",
"clearingCode": "",
"scheduledDate": "2023-04-18T00:00:00Z",
"swiftCode": "BARCGB22",
"clearingIdentifierCode": "",
"intermediaryBicCode": "",
"beneficiaryAddressLine1": "",
"softdeleteflag": false,
"referenceId": "PI231080BKZRLYQC",
"paymentType": "",
"beneficiaryAddressLine2": "",
"streetName": "",
"fromAccountCurrency": "EUR",
"messageDetails": "[{\"id\":\"PI-CHARGE.BEARER.NOT.ALLOWED\",\"message\":\"Bucket Override &{O-12031\"}]",
"beneficiaryPhone": "",
"transactionAmount": "2.0",
"validate": "",
"amount": 2,
"paidBy": "OUR",
"featureActionId": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"overrides": "",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"message": "Success! Your transaction has been completed",
"transactionType": "ExternalTransfer",
"beneficiaryCity": "",
"beneficiaryEmail": "",
"transactionsNotes": "",
"toAccountNumber": "123123",
"purposeCode": "",
"frequencyType": "Once"
}
International Bank Scenario Response
{
"totalAmount": "1",
"amount": 0,
"charges": "",
"opstatus": 0,
"referenceId": "PI231080XBWQRFZW",
"softdeleteflag": false,
"status": "success",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact or Service Request Microservice |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate |
Field Mapping
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact SRMS Payment
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | requestIn.e2eReference | NA |
| clearingCode | clearingCode | requestIn.clearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | requestIn.intermediaryBICCode | NA |
| NA | submitOrder | requestIn.submitOrder | NA |
| From Account | fromAccountNumber | requestIn.fromAccountNumber | NA |
| To Account | toAccountNumber | requestIn.toAccountNumber | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | requestIn.fromAccountCurrency / requestIn.transactionCurrency(INATIONAL) | NA |
| Amount | amount | requestIn.amount | NA |
| Transfer / Payment Reference | transactionsNotes | requestIn.transactionsNotes | NA |
| Frequency | frequencyType | requestIn.frequencyType | NA |
| Send On | scheduledDate | requestIn.scheduledDate | NA |
| Account Number / IBAN | ExternalAccountNumber | requestIn.ExternalAccountNumber | NA |
| SWIFT / BIC | swiftCode | requestIn.swiftCode | NA |
| Fees Paid By | paidBy | requestIn.paidBy | NA |
| Beneficiary Nickname | beneficiaryName | requestIn.beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | requestIn.uploadedattachments | NA |
| transactionId(Request) | transactionId(Request) | requestIn.transactionId(Request) | NA |
| Reference number(Response) | referenceId(Response) | requestIn.referenceId(Response) | NA |
| Total debit | totalAmount | requestIn.totalAmount | NA |
| Exchange Rate | exchangeRate | requestIn.exchangeRate | NA |
| NA | Overrides(Sepa Cut off Time) | requestIn.Overrides | NA |
| Charges Breakdown | charges | requestIn.charges | NA |
| NA | userId | requestIn.userId | NA |
| NA | validate | requestIn.validate | NA |
| NA | transactionType | requestIn.transactionType | NA |
| NA | beneficiaryAddressLine1 | requestIn.beneficiaryAddressLine1 | NA |
| NA | beneficiaryAddressLine2 | requestIn.beneficiaryAddressLine2 | NA |
| NA | beneficiaryBankName | requestIn.beneficiaryBankName | NA |
| NA | beneficiaryCity | requestIn.beneficiaryCity | NA |
| NA | beneficiarycountry | requestIn.beneficiarycountry | NA |
| NA | beneficiaryEmail | requestIn.beneficiaryEmail | NA |
| NA | beneficiaryNickname | requestIn.beneficiaryNickname | NA |
| NA | beneficiaryPhone | requestIn.beneficiaryPhone | NA |
| NA | beneficiaryZipcode | requestIn.beneficiaryZipcode | NA |
| NA | createWithPaymentId | requestIn.createWithPaymentId | NA |
| NA | deletedDocuments | requestIn.deletedDocuments | NA |
| NA | frequencyEndDate | requestIn.frequencyEndDate | NA |
| NA | beneficiaryState | requestIn.beneficiaryState | NA |
| NA | frequencyStartDate | requestIn.frequencyStartDate | NA |
| NA | iban | requestIn.iban | NA |
| NA | serviceName | requestIn.serviceName | NA |
| NA | toAccountCurrency | requestIn.toAccountCurrency | NA |
| NA | numberOfRecurrences | requestIn.numberOfRecurrences | NA |
| NA | isScheduled | requestIn.isScheduled | NA |
| NA | paymentType | requestIn.paymentType | NA |
| bank Name | NA | requestIn.bank Name | NA |
| addressLine1 | NA | requestIn.addressLine1 | NA |
| countryName | NA | requestIn.countryName | NA |
getPayeeName
| Description: | This API fetches the payee name based on the input provide user. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/Payee_Name/getPayeeName |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters accountNumber Specifies the account number of the beneficiary.{
"accountNumber": "131644"
} |
| Response: |
Parameters beneficiaryName Specifies the name of the beneficiary.{
"beneficiaryName": "temenos",
"currency": "EUR",
"opstatus": 0,
"httpStatusCode": 200
} |
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v2.0.0/holdings/accounts?accountId=$accountNumber |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $accountNumber |
| NA | NA | NA | $currency |
getPayeeList
| Description: | This API retrieves the list of beneficiary details. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/Payees/getPayeesList |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters accountNumber Specifies the account number of the beneficiary.{} |
| Response: |
Parameters beneficiaryName Specifies the name of the beneficiary.{
"ExternalAccounts": [
{
"accountNumber": "9993NGB28591150764",
"beneficiaryName": "www",
"createdOn": "2024-03-27",
"isInternationalAccount": "false",
"isSameBankAccount": "true",
"isVerified": "true",
"nickName": "j",
"IBAN": "9993NGB28591150764",
"cif": "[{\"coreCustomerId\":\"190347\",\"contractId\":\"7139227202\"}]",
"Id": "54341748",
"noOfCustomersLinked": "1",
"addressLine2": "sdsd",
"payeeStatus": "Active",
"payeeVerification": "Skipped"
},
{
"accountNumber": "9994NGB28591150764",
"beneficiaryName": "www",
"createdOn": "2024-03-27",
"isInternationalAccount": "false",
"isSameBankAccount": "true",
"isVerified": "true",
"nickName": "j",
"IBAN": "9994NGB28591150764",
"cif": "[{\"coreCustomerId\":\"190347\",\"contractId\":\"7139227202\"}]",
"Id": "98104075",
"noOfCustomersLinked": "1",
"addressLine2": "sdsd",
"payeeStatus": "Active",
"payeeVerification": "Success"
}
],
"opstatus": 0,
"httpStatusCode": 0
} |
| Error Code(s): |
|
| Enterprise Provider: | |
| Enterprise API: |
|
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $accountNumber |
| NA | NA | NA | $currency |
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: | Post |
| URL: | {base_url}//services/data/v1/TransactionObjects/operations/CreditCard/getCreditCardAccounts |
| 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. {
"opstatus": 0,
"Accounts": [{
"accountID": "1901282",
"principalBalance": "10000.00",
"accountName": "Freedom Credit Card",
"nickName": "Freedom Credit",
"accountType": "CreditCard",
"dueDate": "2020-11-10T00:00:00",
"typeDescription": "CreditCard",
"paymentDue": "3726.0",
"currencyCode": "USD",
"minimumDue": "276.0",
"outstandingBalance": "619.61"
}, {
"accountID": "2901282",
"principalBalance": "20000.00",
"accountName": "HDFC Credit Card",
"nickName": "HDFC Credit",
"accountType": "CreditCard",
"dueDate": "2020-11-10T00:00:00",
"typeDescription": "CreditCard",
"paymentDue": "3726.0",
"currencyCode": "USD",
"minimumDue": "276.0",
"outstandingBalance": "629.61"
}, {
"accountID": "3901282",
"principalBalance": "10000.00",
"accountName": "Citi Credit Card",
"nickName": "Citi Credit",
"accountType": "CreditCard",
"dueDate": "2020-11-10T00:00:00",
"typeDescription": "CreditCard",
"paymentDue": "3726.0",
"currencyCode": "USD",
"minimumDue": "276.0",
"outstandingBalance": "629.61"
}],
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | DBX BD |
| Enterprise API: |
{base_url}/services/InfinityTransactionServices/getCreditCardAccounts |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
accountID |
accountID |
NA |
NA |
|
principalBalance |
principalBalance |
NA |
NA |
|
accountName |
accountName |
NA |
NA |
|
nickName |
nickName |
NA |
NA |
|
accountType |
accountType |
NA |
NA |
|
dueDate |
dueDate |
NA |
NA |
|
typeDescription |
typeDescription |
NA |
NA |
|
paymentDue |
paymentDue |
NA |
NA |
|
currencyCode |
currencyCode |
NA |
NA |
|
minimumDue |
minimumDue |
NA |
NA |
|
outstandingBalance |
outstandingBalance |
NA |
NA |
getBankDate
| Description: | This API allows the user to fetch the Banked Server Date. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/RBObjects/operations/Transactions/getBankDate |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {}
|
| Response: |
Parameters date Specifies an array of details on the bank date. companyId Specifies the ID of the company. lastWorkingDate Specifies the last working date of the bank.nextWorkingDate Specifies the working date for the bank currentWorkingDate Specifies the current working date of the bank. {
"date": [{
"companyId": "GB0010001",
"lastWorkingDate": "2021-04-14",
"nextWorkingDate": "2021-04-16",
"currentWorkingDate": "2021-04-15"
}],
"opstatus": 0,
"httpStatusCode": 200
} |
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}//v1.0.0/reference/dates |
| Transact Artifact: | EB.API.DATES.1.0.0 |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $companyId |
| NA | NA | NA | $lastWorkingDate |
| NA | NA | NA | $nextWorkingDate |
| NA | NA | NA | $currentWorkingDate |
getInstructions
| Description: | This API allows the user to fetch the scheduled transactions. |
| Method: | Custom Verb |
| URL: | {base_url}/services/data/v1/Transfers/operations/StandingInstruction/getInstructions |
| 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": 0,
"lastRecordNumber": 1000
}
|
| 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 Specifs 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 transaction 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) fileName Specifies the name of the file. fileId Specifies the unique ID of the file. View the Sample Response Code for Mock Services
{
"StandingInstruction": [{
"amount": "1",
"description": "Transfer To Current Account",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118664",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "Current Account",
"toAccountNumber": "118621",
"transactionDate": "2021-04-16",
"transactionId": "118664.1",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"payeeCurrency": "USD",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "5",
"description": "Transfer To Domestic",
"frequencyStartDate": "2021-04-19",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118656",
"isScheduled": "true",
"scheduledDate": "2021-04-19",
"toAccountName": "Domestic",
"toAccountNumber": "GB04BARC20474473160944",
"transactionDate": "2021-04-19",
"transactionId": "118656.3",
"transactionType": "ExternalTransfer",
"IBAN": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"payeeCurrency": "EUR",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Domestic",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "1",
"description": "Transfer To Domestic",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118656",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "Domestic",
"toAccountNumber": "GB04BARC20474473160944",
"transactionDate": "2021-04-16",
"transactionId": "118656.4",
"transactionType": "ExternalTransfer",
"IBAN": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"payeeCurrency": "EUR",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Domestic",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "1",
"description": "Transfer To Robert Branson",
"ExternalAccountNumber": "100037",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118656",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "Robert Branson",
"toAccountNumber": "100037",
"transactionDate": "2021-04-16",
"transactionId": "118656.5",
"transactionType": "ExternalTransfer",
"transactionCurrency": "EUR",
"payeeCurrency": "EUR",
"serviceName": "INTRA_BANK_FUND_TRANSFER_CREATE",
"beneficaryName": "Robert Branson",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "1",
"description": "Transfer To Current Account",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118664",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "Current Account",
"toAccountNumber": "118621",
"transactionDate": "2021-04-16",
"transactionId": "118664.2",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"payeeCurrency": "USD",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "1",
"description": "Transfer To Current Account",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118664",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "Current Account",
"toAccountNumber": "118621",
"transactionDate": "2021-04-16",
"transactionId": "118664.3",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"payeeCurrency": "USD",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "5",
"description": "Transfer To dOMESTIC",
"frequencyEndDate": "2021-04-22",
"frequencyStartDate": "2021-04-19",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118656",
"isScheduled": "true",
"scheduledDate": "2021-04-19",
"toAccountName": "dOMESTIC",
"toAccountNumber": "GB53BARC20652670299332",
"transactionDate": "2021-04-19",
"transactionId": "118656.1",
"transactionType": "ExternalTransfer",
"IBAN": "GB53BARC20652670299332",
"transactionCurrency": "EUR",
"payeeCurrency": "EUR",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "dOMESTIC",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "1",
"description": "Transfer To International",
"ExternalAccountNumber": "34567",
"frequencyStartDate": "2021-04-16",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118664",
"isScheduled": "true",
"scheduledDate": "2021-04-16",
"toAccountName": "International",
"toAccountNumber": "34567",
"transactionDate": "2021-04-16",
"transactionId": "118664.4",
"transactionType": "ExternalTransfer",
"transactionCurrency": "USD",
"payeeCurrency": "USD",
"serviceName": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "International",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}, {
"amount": "5",
"description": "Transfer To Domestic",
"frequencyEndDate": "2021-04-23",
"frequencyStartDate": "2021-04-19",
"frequencyType": "Daily",
"fromAccountName": "Current Account",
"fromAccountNumber": "118656",
"isScheduled": "true",
"scheduledDate": "2021-04-19",
"toAccountName": "Domestic",
"toAccountNumber": "GB04BARC20474473160944",
"transactionDate": "2021-04-19",
"transactionId": "118656.2",
"transactionType": "ExternalTransfer",
"IBAN": "GB04BARC20474473160944",
"transactionCurrency": "EUR",
"payeeCurrency": "EUR",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficaryName": "Domestic",
"paidBy": "Both",
"statusDescription": "Active",
"pendingApproval": false
}],
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v1.0.0/order/standingOrders?accountId=$accountId&page_start=$page_start&page_size=$lastRecordNumber |
Field Mapping
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| NA | amount | Not Appilcable | amount |
| NA | description | Not applicable | NA |
| NA | frequencyStartDate | Not applicable | startDate |
| NA | frequencyType | NA | currentFrequency |
| NA | fromAccountName | NA | accountName |
| NA | fromAccountNumber | NA | fromAccountNumber |
| NA | isScheduled | NA | NA |
| NA | scheduledDate | NA | startDate |
| NA | toAccountName | NA | creditAccountName |
| NA | toAccountNumber | NA | creditAccountId |
| NA | transactionDate | NA | NA |
| NA | transactionId | NA | standingOrderId |
| NA | transactionType | NA | paymentMethod |
| NA | transactionCurrency | NA | NA |
| NA | payeeCurrency | NA | payeeCurrency |
| NA | serviceName | NA | NA |
| NA | statusDescription | NA | NA |
| NA | pendingApproval | NA | NA |
| NA | NA | NA | paymentOrderProductName |
| NA | frequencyEndDate | NA | currentEndDate |
isValidIBAN
| Description: | This API allows the user to validate the International Bank Account Number (IBAN). |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/BankDetails/isValidIBAN |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters iban Specifies the unique International bank account number. {
"iban": "GB04BARC20474473160944"
}
|
| Response: |
Parameters iban Specifies the unique International bank account number. isIBANValid Specifies if IBAN is valid or not.{
"iban": "GB13DEMO60161300118656",
"isIBANValid": "YES",
"status": "success",
"opstatus": 0,
"httpStatusCode": 200
} |
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v2.0.0/reference/bankCodes/ibans/$iban/validity |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $iban |
getBICFromBankDetails
| Description: | This API allows the user to fetch the Bank Identifier Code (BIC) from the bank. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/BankDetails/getBICFromBankDetails |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters iban Specifies the unique International bank account number. countryCode Specifies the unique country code.{
"bankName": "BANK",
"country": "",
"city": ""
} |
| Response: |
Parameters country Specifies the country name. sepaMember Specifies if the payee is a sepamember. bankName Specifies the name of the bank. bic Specifies the BIC code.{
"opstatus": 0,
"swiftCodes": [{
"country": "",
"city": "ACCRINGTON",
"bankName": "NATIONAL WESTMINSTER BANK PLC",
"bic": ""
}, {
"country": "",
"city": "SWANSEA",
"bankName": "LLOYDS TSB BANK PLC",
"bic": ""
}, {
"country": "",
"city": "GLASGOW SAUCHIEHALL STREET",
"bankName": "BANK OF CHINA",
"bic": ""
}, {
"country": "INDONESIA",
"city": "DENPASAR",
"bankName": "PT. BANK PEMBANGUNAN DAERAH BALI",
"bic": "ABALIDBSXXX"
}, {
"country": "KAZAKHSTAN",
"city": "ALMATY",
"bankName": "JSC 'FIRST HEARTLAND BANK'",
"bic": "ABNAKZKXXXX"
}, {
"country": "LUXEMBOURG",
"city": "LUXEMBOURG",
"bankName": "ABN AMRO BANK LUXEMBOURG S.A.",
"bic": "ABNALU2AXXX"
}, {
"country": "",
"city": "BUDAPEST",
"bankName": "CITIBANK EUROPE PLC",
"bic": "CITIHUHXXXX"
}, {
"country": "",
"city": "COLOMBO",
"bankName": "BANK OF CEYLON",
"bic": "BCEYLKLXXXX"
}, {
"country": "",
"city": "COLOMBO",
"bankName": "CITIBANK Srilanka",
"bic": "CITILKLXXXX"
}, {
"country": "",
"city": "BANGUI",
"bankName": "ECOBANK CENTRAFRIQUE",
"bic": "ECOCCFCFXXX"
}],
"httpStatusCode": 200
} |
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v3.0.0/reference/BankCodes/BICs?bankName='$bankName'&country='$country'&city='$city' |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $bankName |
| NA | NA | NA | $country |
| NA | NA | NA | $bic |
| NA | NA | NA | $city |
getBankDetailsFromBicCode
| Description: | This API retrieves the payee bank name from core, when user keys in payee bank BIC. |
| Method: | POST |
| URL: | {base_url}//services/data/v1/PayeeManagement/operations/BankDetails/getBankDetailsFromBicCode |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters swiftCode (Mandatory) Specifies the swift code.{
"swiftCode": "DRESDEFF"
} |
| Response: |
Parameters countryCode(Mandatory) Specifies the country code. addressLine1(Mandatory) Specifies address of the bank. bankName(Mandatory) Specifies the name of the bank. isBICValid(Mandatory) Specifies BIC code is a valid code or not. countryName (Mandatory) Specifies the country name of the bank. {
"countryCode": "DE",
"addressLine1": "Germany",
"bankName": "DRESDNER BANK AG",
"isBICValid": "YES",
"countryName": "GERMANY",
"opstatus": 0,
"httpStatusCode": 200
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v3.0.0/reference/bankCodes/bics/$swiftCode |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $swiftCode |
getSwiftCode
| Description: | This API allows the user to fetch the Swift Code from the bank. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/BankDetails/getSwiftCode |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters iban Specifies the unique International bank account number. countryCode Specifies the unique country code.{
"iban": "GB04BARC20474473160944",
"countryCode": "GB"
} |
| Response: |
Parameters country Specifies the countyr name . sepaMember Specifies if the payee is a sepamember. bankName Specifies the name of the bank. bic Specifies the BIC code.{
"country": "LONDON",
"sepaMember": "Y",
"bankName": "BARCLAYS BANK BRANCH B22",
"bic": "BARCGB22",
"opstatus": 0,
"httpStatusCode": 200
} |
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
{base_url}/v2.0.0/reference/bankCodes/countries/$countryCode/ibanStructures {base_url}/v2.0.0/reference/bankCodes/ibans/$iban/bic |
Field Mapping
| UI Field | Experience API Field | MS API Field | Transact API Field |
|---|---|---|---|
| NA | NA | NA | $countryCode |
| NA | NA | NA | $iban |
| NA | NA | NA | $bankName |
| NA | NA | NA | $bic |
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: | {base_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. fromDate Specifies the start date from when the the account had been blocked. lockedAmount Specifies the value of the amount that has been blocked. transactionReference Specifies the alternate reference id for the transaction that is locked. toDate Specifies the end date up to when the account had been blocked.. lockedEventId Specifies the reference id for the transaction that is locked. 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"
}
]
|
| Enterprise Provider: | Transact |
| Enterprise API: | {Base_URL}/api/v2.0.0/holdings/accounts/reservedFunds?$filter |
| Transact Artifact: | AC.API.ACCOUNT.RESERVED.FUNDS.1.0.0 |
retrieveAttachments
| Description: | Retrieves the documents stored in the database or Document Management System (DMS) based on the referenceId. This API is used in the Payments and Transfers Flow and in Accounts Transaction flow. | |||||
| Method: | POST | |||||
| URL: | {BASE_URL}/services/data/v1/RBObjects/operations/DownloadAttachments/retrieveAttachments | |||||
| Security Level: | Authenticated App Users | |||||
| Header Request: |
|
|||||
| Body Request: |
Parameters referenceId (Mandatory) Specifies the unique ID attached to every document present in the DB or DMS. {
"referenceId":"12088”
}
|
|||||
| Response: |
Parameters fileNames Specifies an array of files in a JSON Objects. fileName Specifies the name of the file fileID Specifies the unique ID of the file. {
"fileNames": [
{
"fileName": "1637906901.pdf",
"fileID": "u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
},
{
"fileName": "1637906901.pdf",
"fileID": "u07CBJv82zHOh9jqrG9lX3XB9P3PmqWw"
}
]
}
Error Response {
"opstatus": 0,
"fileNames": [],
"httpStatusCode": 0
}
|
|||||
| Service Flow: |
|
getTransactionStatementsByYear
| Description: | Retrieves the transaction statements from the backend. | ||
| Method: | POST | ||
| URL: | {base_url}/services/data/v1/TransactionAdvice/operations/TransactionStatement/getTransactionStatementsByYear | ||
| Security Level: | Authenticated App Users | ||
| Header Request: |
|
||
| Body Request: |
Parameters page Specifies the page number of the transaction statement. accountNumber Specifies the account number of the user. customerNumber Specifies the number associated with the customer. year Specifies the year associated with the transaction statement. subType Specifies the sub type of the transaction statement. {
"page": "1",
"accountNumber": "110008",
"customerNumber": "193466",
"year": "2020",
"subType": "Statement"
}
|
||
| Response: | {
"June": [
{
"file 0": "Statement_30-June-2020.pdf/12884906631"
}
],
"May": [
{
"file 0": "Statement_31-May-2020.pdf/12884906632"
}
],
"September": [
{
"file 0": "Statement_30-September-2020.pdf/12884906624"
}
],
"opstatus": 0,
"March": [
{
"file 0": "Statement_29-March-2020.pdf/12884906634"
}
],
"July": [
{
"file 0": "Statement_27-July-2020.pdf/12884906629",
"file 1": "Statement_20-July-2020.pdf/12884906628",
"file 2": "Statement_13-July-2020.pdf/12884906627",
"file 3": "Statement_06-July-2020.pdf/12884906626"
}
],
"January": [
{
"file 0": "Statement_31-January-2020.pdf/12884906636"
}
],
"February": [
{
"file 0": "Statement_28-February-2020.pdf/12884906635"
}
],
"April": [
{
"file 0": "Statement_30-April-2020.pdf/12884906633"
}
],
"httpStatusCode": 0,
"August": [
{
"file 0": "Statement_31-August-2020.pdf/12884906625"
}
]
}
|
||
| Error Codes: |
|
||
| Associated Services: |
|
downloadStatements
| Description: | Downloads the account statements. | ||
| Method: | POST | ||
| URL: | {BASE_URL}/services/data/v1/TransactionAdvice/objects/TransactionStatement | ||
| Security Level: | Authenticated App Users | ||
| Header Request: |
|
||
| Body Request: |
Parameters mediaType (Mandatory) Specifies the format of the file that is to be downloaded. fileName (Mandatory) Specifies the name of the file. id (Mandatory) Specifies the unique ID of the file. revision (Mandatory) Specifies the number of revisions for the file. Auth_Token (Mandatory) Specifies the authorization token that is to be passed for a successfull download. {
"mediaType": "pdf",
"fileName": "dosSuc",
"id": "12884906629",
"revision": "1",
"Auth_Token": "eyAidHlwIjogImp3dCIsICJhbGciOiAiUlMyNTYiIH0.eyAiX2VtYWlsIjogInZlbmthdGEuY2hhbGxhZ3VuZGxhQHRlbWVub3MuY29tIiwgIl92ZXIiOiAidjEuMSIsICJpc3MiOiAiaHR0cDovL2toMTU3NC50ZW1lbm9zZ3JvdXAuY29tOjgwODEvYXV0aFNlcnZpY2UvMTAwMDAwMDAyIiwgIl9zY29wZSI6ICJnIiwgIl9pc3NtZXRhIjogIi9tZXRhZGF0YS9RS1UtWmpXT1ZmbVdhZ2FGTS1MMU13PT0iLCAiX2FwcCI6ICI1NGVjYWE3YS00Y2EyLTQ3OGEtYTJkOC0zY2U4ZmUyMGM5ZmUiLCAiX3Nlc3Npb25faWQiOiAiY2VlODc5OTktZDM5Mi00YTljLThmNTMtZjVjMzVhOTU5NjU4IiwgIl9wdWlkIjogMjE0MzQ1NDUyODg5NzE0ODg0MiwgIl9hdXRoeiI6ICJleUp3WlhKdGFYTnphVzl1Y3lJNmUzMHNJbkp2YkdWeklqcGJYWDAiLCAiX2lkcCI6ICJsb2dpbmR1bSIsICJleHAiOiAxNTk5MTE4MTE1LCAiaWF0IjogMTU5OTExNjkxNSwgIl9zZXNzaW9uX3RpZCI6ICIxMDAwMDAwMDIiLCAiX3Byb3ZfdXNlcmlkIjogInZlbmthdGEuY2hhbGxhZ3VuZGxhQHRlbWVub3MuY29tIiwgImp0aSI6ICIzZmZjMWE2Zi0wMjQzLTQ4MTEtYjc5NS1lZjllMTMwZjlmMWEiLCAiX2FjcyI6ICIxMDAwMDAwMDIiLCAiX3Byb3ZpZGVycyI6IFsgImxvZ2luZHVtIiBdIH0.TFvNrug4ApfB4Maai12WBb74xu7AdkU5b-hgpKBC5v7XFk9MuraaMhArywggQ_EG2E18uAdTh45vkPTXU9F_ZEzYExhUUPqYt9bnU6cA9piQXPqzIujAt7M8vB1ipvV-BYeEflpxeFoh8yAztvZ9NkE7OEJG9ktsY79ZtyuK2bbcGXT46IkN8Ie9IbLH7aIFBKZACba9ItXS308zeF60IORJAEWsv0JBzvgQVCg5nD_bhuzD6zVq9dBuWYH_xAfqJGGMUh0OmMqEAmLaRa_LMGaSTtgQZESIJT1_pyeMSt9GATof9hcsaC8EIts4yFBuAI9OQPvIT7pDjBq9jk_7jA"
}
|
||
| Response: |
Downloads the Base64 format of the PDF document |
||
| Associated Services: |
|
createPayee
| Description: | This API creates payee in the UTF / Euro flow. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/Payees/createPayee |
| Security Level: | Authenticated App Users |
| Header Request: |
|
| Body Request: |
Parameters accountNumber Specifies the International bank account number. IBAN Specifies the international bank account number. beneficiaryName Specifies the beneficiary name to whom the amount will be credited. bankName Specifies the name of the bank. nickName Specifies the nick name of the payee. zipcode Specifies the zipcode of the bank. phone Specifies the phone number of the payee. Specifies the email address of the payee. swiftCode Specifies the swift code of the bank. isVerfied Specifies whether the account is verified or not. isSameBankAccount Specifies whether it is the same bank account or not. isInternationalAccount Specifies whether it is an international account. feature Specifies the feature to create a beneficiary singleCustomer Specifies whether the user is single cif or not cif Specifies the cif of the payee. {
"accountNumber": "29928NGB28591150764",
"IBAN": "29928NGB28591150764",
"beneficiaryName": "www",
"bankName": "",
"nickName": "ganga",
"addressLine1": "",
"addressLine2": "sdsd",
"city": "",
"zipcode": "",
"email": "",
"state": "",
"swiftCode": "BARCGB22",
"country": "GB",
"phone": "",
"sameBank": "",
"otherBank": "",
"isVerified": "true",
"isSameBankAccount": "true",
"isInternationalAccount": "false",
"feature": "INTERNATIONAL_ACCOUNT_FUND_TRANSFER_CREATE_RECEPIENT",
"singleCustomer": "true",
"cif": "[{\"contractId\":\"7139227202\",\"coreCustomerId\":\"190347\"}]",
"clearingCode": "",
"clearingIdentifierCode": "ATBLZ",
"verifyPayee": "true"
}
|
| Response: |
Parameters Id Specifies the identification number of the payee. {
"Id": "51137146",
"payeeVerificationStatus": "Success",
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/createExternalPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
Id |
Id |
NA |
NA |
|
accountNumber |
accountNumber |
NA |
NA |
|
IBAN |
IBAN |
NA |
NA |
|
swiftCode |
swiftCode |
NA |
NA |
|
sameBank |
sameBank |
NA |
NA |
|
otherBank |
otherBank |
NA |
NA |
|
feature |
feature |
NA |
NA |
|
contractId |
contractId |
NA |
NA |
|
coreCustomerId |
coreCustomerId |
NA |
NA |
editPayee
| Description: | This API edits the list of payees in the UTF/Euro flow. |
| Method: | GET |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/Payees/editPayee |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters accountNumber (Mandatory) Specifies the unique account number. phone (Mandatory) Specifies the mobile number of the payee. payeeId (Mandatory) Specifies the beneficiaryName (Mandatory) Specifies the nickName Specifies the city (Mandatory) Specifies the email (Mandatory) Specifies the isSameBankAccount (Mandatory) Specifies the isInternationalAccount (Mandatory) Specifies the contractId (Mandatory) Specifies the coreCustomerId (Mandatory) Specifies the {
"accountNumber": "131644",
"payeeId": "99829604",
"isSameBankAccount": "false",
"isInternationalAccount": "false",
"beneficiaryName": "Barclays",
"nickName": "Barclays",
"city": " ",
"phone": "",
"email": "temenos@temenos.com",
"cif": "[{\"contractId\":\"3206059598\",\"coreCustomerId\":\"303030\"}]"
}
|
| Response: |
Parameters Id Specifies the unique Id.{
"Id": "99829604",
"opstatus": 0,
"httpStatusCode": 0
} |
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/editExternalPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
Id |
Id |
NA |
NA |
|
accountNumber |
accountNumber |
NA |
NA |
|
payeeId |
payeeId |
NA |
NA |
|
isSameBankAccount |
isSameBankAccount |
NA |
NA |
|
isInternationalAccount |
isInternationalAccount |
NA |
NA |
|
beneficiaryName |
beneficiaryName |
NA |
NA |
|
nickName |
nickName |
NA |
NA |
|
|
|
NA |
NA |
|
contractId |
contractId |
NA |
NA |
|
coreCustomerId |
coreCustomerId |
NA |
NA |
getPayees
| Description: | This API retrieves the list of same bank, domestic, and international payees. |
| Method: | POST |
| URL: | {base_url}services/data/v1/DigitalTransfer/operations/Payee_P2P/getP2PPayees |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: | {}
|
| Response: | {
"ExternalAccounts": [{
"accountNumber": "NL91ABNA0417164300",
"beneficiaryName": "Domestic",
"createdOn": "2021-11-25",
"isInternationalAccount": "false",
"isSameBankAccount": "false",
"isVerified": "true",
"nickName": "Domtest",
"swiftCode": "ABNANL2A",
"IBAN": "NL91ABNA0417164300",
"phoneNumber": "6096922310",
"cif": [{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}],
"Id ": "44543905 ",
"noOfCustomersLinked ": "1 ",
"addressLine2 ": "Two ",
"phone ": "6096922310 ",
"email ": "newmail@ gmail.com ",
"country ": "Albania ",
"city ": "uhuh ",
"addressLine1 ": "One "
}, {
"accountNumber ": "120642 ",
"beneficiaryName ": "Retail User3463 ",
"createdOn ": "2021 - 11 - 30 ",
"isInternationalAccount ": "false ",
"isSameBankAccount ": "true ",
"isVerified ": "true ",
"nickName ": "nick ",
"IBAN ": "120642 ",
"phoneNumber ": "9898989898 ",
"cif ": [{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}],
"Id ": "70220408 ",
"noOfCustomersLinked ": "1 ",
"addressLine2 ": "3rdfloor ",
"phone ": "9898989898 ",
"email ": "retail@ temenos.com ",
"country ": "India ",
"city ": "chennai ",
"zipcode ": "123212 ",
"addressLine1 ": "south street "
},
{
"accountNumber ": "106127 ",
"beneficiaryName ": "Universal Studios ",
"createdOn ": "2021 - 11 - 25 ",
"isInternationalAccount ": "false ",
"isSameBankAccount ": "true ",
"isVerified ": "true ",
"nickName ": "Same 1 ",
"IBAN ": "106127 ",
"phoneNumber ": "8876543215 ",
"cif ":
[{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}],
"Id ": "65436963 ",
"noOfCustomersLinked ": "1 ",
"addressLine2 ": "Rrrrrr ",
"phone ": "8876543215 ",
"email ": "BBB@ gmail.com ",
"country ": "Rrrrrr ",
"city ": "222222 ",
"zipcode ": "222222 ",
"addressLine1 ": "2 "
}, {
"accountNumber ": "106682 ",
"beneficiaryName ": "Serge Dassault ",
"createdOn ": "2021 - 11 - 26 ",
"isInternationalAccount ": "false ",
"isSameBankAccount ": "true ",
"isVerified ": "true ",
"IBAN ": "106682 ",
"cif ": "
[{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}]
",
"Id ": "13430322 ",
"noOfCustomersLinked ": "1 "
}, {
"accountNumber ": "120634 ",
"beneficiaryName ": "Retail User3463 ",
"createdOn ": "2021 - 11 - 30 ",
"isInternationalAccount ": "false ",
"isSameBankAccount ": "true ",
"isVerified ": "true ",
"nickName ": "Nick ",
"IBAN ": "120634 ",
"phoneNumber ": "87876512672 ",
"cif ": "
[{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}]
",
"Id ": "95948149 ",
"noOfCustomersLinked ": "1 ",
"addressLine2 ": "Address2 ",
"phone ": "87876512672 ",
"email ": "retail@ temenos.com ",
"country ": "India ",
"city ": "Chennai ",
"zipcode ": "1221312 ",
"addressLine1 ": "Address1 "
}, {
"accountNumber ": "123456 ",
"beneficiaryName ": "International ",
"createdOn ": "2021 - 11 - 25 ",
"isInternationalAccount ": "true ",
"isSameBankAccount ": "false ",
"isVerified ": "true ",
"nickName ": "Int ",
"swiftCode ": "BARCGB22 ",
"IBAN ": "123456 ",
"phoneNumber ": "9998887774 ",
"cif ": "
[{
"coreCustomerId ": "800252 ",
"contractId ": "1527321218 "
}]
",
"Id ": "12556317 ",
"noOfCustomersLinked ": "1 ",
"addressLine2 ": "Rrrr ",
"phone ": "9998887774 ",
"email ": "uuuu@ gmail.com ",
"country ": "Yyyy ",
"city ": "55555 ",
"zipcode ": "55555 ",
"addressLine1 ": "5 "
}],
"opstatus ": 0,
"httpStatusCode ": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: |
Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/getExternalPayees |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
accountNumber |
accountNumber |
NA |
NA |
|
beneficiaryName |
beneficiaryName |
NA |
NA |
|
createdOn |
createdOn |
NA |
NA |
|
isInternationalAccount |
isInternationalAccount |
NA |
NA |
|
isSameBankAccount |
isSameBankAccount |
NA |
NA |
|
isVerified |
isVerified |
NA |
NA |
|
nickName |
nickName |
NA |
NA |
|
swiftCode |
swiftCode |
NA |
NA |
|
IBAN |
IBAN |
NA |
NA |
|
phoneNumber |
phoneNumber |
NA |
NA |
|
coreCustomerId |
coreCustomerId |
NA |
NA |
|
contractId |
contractId |
NA |
NA |
|
Id |
Id |
NA |
NA |
|
noOfCustomersLinked |
noOfCustomersLinked |
NA |
NA |
|
addressLine2 |
addressLine2 |
NA |
NA |
|
phone |
phone |
NA |
NA |
|
|
|
NA |
NA |
|
country |
country |
NA |
NA |
|
zipcode |
zipcode |
NA |
NA |
|
city |
city |
NA |
NA |
deletePayee
| Description: | This API deletes payees in the UTF/Euro flow. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/PayeeManagement/operations/Payees/deletePayee |
| Security Level: | Authenticated App User |
| Header Request: | X-Kony-Authorization |
| Body Request: |
Parameters accountNumber Specifies the unique accountNumber. payeeId Specifies the unique payeeId. isSameBankAccount Specifies if the account is within in the same bank account number. isInternationalAccount Specifies if it is a international account . {
"accountNumber": "131644",
"payeeId": "99829604",
"isSameBankAccount": "false",
"isInternationalAccount": "false"
}
|
| Response: |
Parameters Id Specifies the unique Id.{
"Id": "99829604",
"opstatus": 0,
"httpStatusCode": 0,
"deletedRecords": "1"
} |
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/dbpPayeeServices/deleteExternalPayee |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
Id |
Id |
NA |
NA |
|
accountNumber |
accountNumber |
NA |
NA |
|
isSameBankAccount |
isSameBankAccount |
NA |
NA |
|
isInternationalAccount |
isInternationalAccount |
NA |
NA |
|
payeeId |
payeeId |
NA |
NA |
Create(FX rate & Credit Value)
| Description: | This API retrieves the charges, FX rate & credit value date for the transfer & display on screen. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Transfers/operations/OneTimeTransfer/Create |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters frequencyType Specifies the frequency of the transaction. transactionID Specifies the unique ID of the transaction. transactionType Specifies the type of the transaction. {
"ExternalAccountNumber": "GB47DEMO60161300104949",
"amount": "1.00",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiaryBankName": "DEMO BIC FOR MODEL BANK, GB",
"beneficiaryCity": "",
"beneficiarycountry": "",
"beneficiaryEmail": "",
"beneficiaryName": "payee",
"beneficiaryNickname": "",
"beneficiaryPhone": "",
"beneficiaryState": "",
"beneficiaryZipcode": "",
"clearingCode": "codes",
"createWithPaymentId": "true",
"deletedDocuments": "",
"e2eReference": "",
"frequencyEndDate": "",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyType": "Once",
"fromAccountCurrency": "EUR",
"fromAccountNumber": "131644",
"iban": "",
"intermediaryBicCode": "",
"isScheduled": "0",
"numberOfRecurrences": "",
"paidBy": "SHA",
"paymentType": "INSTPAY",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"swiftCode": "DEMOGBPX",
"toAccountCurrency": "EUR",
"toAccountNumber": "GB47DEMO60161300104949",
"transactionCurrency": "EUR",
"transactionId": "",
"transactionType": "ExternalTransfer",
"transactionsNotes": "",
"uploadedattachments": "",
"userId": "",
"validate": "true"
}
|
| Response: |
Parameters ID Specifies the reference ID of the transaction {
"Id": "99829604",
"opstatus": 0,
"httpStatusCode": 0,
"deletedRecords": "1"
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
Create(Recurring Transfer Request)
| Description: | This API submits the adhoc transfer/ recurring transfer request. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/Transfers/operations/OneTimeTransfer/Create |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters frequencyType Specifies the frequency of the transaction. transactionID Specifies the unique ID of the transaction. transactionType Specifies the type of the transaction. {
"amount": "1.00",
"transactionId": "PI211050F2LPCF7T",
"frequencyType": "Once",
"fromAccountNumber": "131644",
"iban": "",
"isScheduled": "0",
"frequencyStartDate": "2021-04-15T00:00:00.000Z",
"frequencyEndDate": "",
"scheduledDate": "2021-04-15T00:00:00.000Z",
"numberOfRecurrences": "",
"toAccountNumber": "GB47DEMO60161300104949",
"paymentType": "INSTPAY",
"paidBy": "SHA",
"swiftCode": "DEMOGBPX",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"beneficiaryName": "payee",
"beneficiaryNickname": "",
"transactionsNotes": "",
"transactionType": "ExternalTransfer",
"transactionCurrency": "EUR",
"fromAccountCurrency": "EUR",
"toAccountCurrency": "EUR",
"ExternalAccountNumber": "GB47DEMO60161300104949",
"uploadedattachments": "",
"clearingCode": "codes",
"intermediaryBicCode": "",
"e2eReference": "",
"charges": "",
"exchangeRate": "",
"totalAmount": "1",
"creditValueDate": "",
"transactionAmount": "1.00",
"userId": "",
"deletedDocuments": "",
"createWithPaymentId": "true",
"beneficiaryBankName": "DEMO BIC FOR MODEL BANK, GB",
"beneficiaryAddressLine1": "",
"beneficiaryAddressLine2": "",
"beneficiarycountry": "",
"beneficiaryState": "",
"beneficiaryCity": "",
"beneficiaryZipcode": "",
"beneficiaryPhone": "",
"beneficiaryEmail": ""
}
|
| Response: |
Parameters transactionID Specifies the unique ID of the transaction referenceID Specifies the reference ID of the transaction {
"beneficiaryZipcode": "",
"fromAccountNumber": "131644",
"processingDate": "2021-04-15T00:00:00Z",
"clearingCode": "codes",
"swiftCode": "DEMOGBPX",
"scheduledDate": "2021-04-15T00:00:00Z",
"isScheduled": "0",
"beneficiaryAddressLine1": "",
"intermediaryBicCode": "",
"referenceId": "PI211050F2LPCF7T",
"paymentType": "INSTPAY",
"beneficiaryAddressLine2": "",
"fromAccountCurrency": "EUR",
"serviceCharge": "0.0",
"exchangeRate": "",
"beneficiaryBankName": "DEMO BIC FOR MODEL BANK, GB",
"paymentId": "209",
"beneficiaryName": "payee",
"beneficiaryPhone": "",
"transactionAmount": "1.0",
"beneficiarycountry": "",
"e2eReference": "",
"accountCode": "131644",
"beneficiaryState": "",
"amount": 1,
"transactionCurrency": "EUR",
"paidBy": "SHA",
"featureActionId": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"overrides": "",
"accountHolderNumber": "GB47DEMO60161300104949",
"transferId": "209",
"serviceName": "INTER_BANK_ACCOUNT_FUND_TRANSFER_CREATE",
"message": "Success! Your transaction has been completed",
"transactionId": "209",
"transactionType": "ExternalTransfer",
"beneficiaryCity": "",
"totalAmount": "1",
"beneficiaryEmail": "",
"companyId": "6803408029_666666",
"charges": "",
"transactionsNotes": "",
"toAccountNumber": "GB47DEMO60161300104949",
"frequencyType": "Once",
"dbxtransactionId": "209",
"opstatus": 0,
"transferLocator": "209",
"status": "Sent",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Transact or Service Request Microservice |
| Enterprise API: |
Transact Standing Order - {base_url}/v1.0.0/order/standingOrders/$fromAccountNumber?validate_only=$validate Transact Payment Order - {base_url}/v1/payments/paymentOrder?validate_only=$validate SRMS Payment - {base_url}/orders/party/$partyId/type/$type/subtype/$subtype/serviceRequest |
Field Mapping
Transact Standing Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | No matching SS fields | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | currencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | displayName | NA |
| Frequency | frequencyType | frequency | NA |
| Send On | frequencyStartDate | startDate | NA |
| Ending On | frequencyEndDate | endDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | beneficiaryBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId | transactionId | standingOrderId | NA |
| Reference number(Response) | referenceId(Response) | id | NA |
| NA | userId | NA | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentMethod | NA |
| NA | isScheduled | NA | NA |
| NA | frequencyStartDate | startDate | NA |
Transact Payment Order
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | endToEndReference | NA |
| clearingCode | clearingCode | accountWithBankClearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | NA | NA |
| NA | submitOrder | NA | NA |
| From Account | fromAccountNumber | debitAccountId | NA |
| To Account | toAccountNumber | creditAccountId | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | paymentCurrencyId | NA |
| Amount | amount | amount | NA |
| Transfer / Payment Reference | transactionsNotes | remittanceInformation / instructionIdReference(SEPA / INSTPAY) | NA |
| Frequency | frequencyType | NA | NA |
| Send On | scheduledDate | executionDate | NA |
| Account Number / IBAN | ExternalAccountNumber | beneficiaryAccountId / beneficiaryIBAN(SEPA / INSTPAY) | NA |
| SWIFT / BIC | swiftCode | accountWithBankBIC | NA |
| Fees Paid By | paidBy | chargeBearer | NA |
| Beneficiary Nickname | beneficiaryName | beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | NA | NA |
| transactionId(Request) | transactionId(Request) | paymentOrderId(Request) | NA |
| Reference number(Response) | referenceId(Response) | id(Response) | NA |
| Total debit | totalAmount | totalDebitAmount (Response) | NA |
| Exchange Rate | exchangeRate | indicativeRate (Response) | NA |
| NA | Overrides(Sepa Cut off Time) | overrides / overrideList | NA |
| Charges Breakdown | charges | charges (Json Array to String) (Response) | NA |
| NA | userId | orderingCustomerId | NA |
| NA | validate | validate | NA |
| NA | transactionType | paymentOrderProductId | NA |
| NA | beneficiaryAddressLine1 | NA | NA |
| NA | beneficiaryAddressLine2 | NA | NA |
| NA | beneficiaryBankName | NA | NA |
| NA | beneficiaryCity | NA | NA |
| NA | beneficiarycountry | NA | NA |
| NA | beneficiaryEmail | NA | NA |
| NA | beneficiaryNickname | NA | NA |
| NA | beneficiaryPhone | NA | NA |
| NA | beneficiaryZipcode | NA | NA |
| NA | createWithPaymentId | NA | NA |
| NA | deletedDocuments | NA | NA |
| NA | frequencyEndDate | NA | NA |
| NA | beneficiaryState | NA | NA |
| NA | frequencyStartDate | NA | NA |
| NA | iban | NA | NA |
| NA | serviceName | NA | NA |
| NA | toAccountCurrency | NA | NA |
| NA | numberOfRecurrences | NA | NA |
| NA | isScheduled | NA | NA |
| NA | paymentType | NA | NA |
| NA | NA | localInstrumentCode | NA |
| bank Name | NA | NA | NA |
| addressLine1 | NA | NA | NA |
| countryName | NA | NA | NA |
Transact SRMS Payment
| UI API field | Experience API field | MS API field | Transact API field |
|---|---|---|---|
| e2eReference | e2eReference | requestIn.e2eReference | NA |
| clearingCode | clearingCode | requestIn.clearingCode | NA |
| intermediaryBICCode | intermediaryBICCode | requestIn.intermediaryBICCode | NA |
| NA | submitOrder | requestIn.submitOrder | NA |
| From Account | fromAccountNumber | requestIn.fromAccountNumber | NA |
| To Account | toAccountNumber | requestIn.toAccountNumber | NA |
| Currency | fromAccountCurrency / transactionCurrency(INATIONAL) | requestIn.fromAccountCurrency / requestIn.transactionCurrency(INATIONAL) | NA |
| Amount | amount | requestIn.amount | NA |
| Transfer / Payment Reference | transactionsNotes | requestIn.transactionsNotes | NA |
| Frequency | frequencyType | requestIn.frequencyType | NA |
| Send On | scheduledDate | requestIn.scheduledDate | NA |
| Account Number / IBAN | ExternalAccountNumber | requestIn.ExternalAccountNumber | NA |
| SWIFT / BIC | swiftCode | requestIn.swiftCode | NA |
| Fees Paid By | paidBy | requestIn.paidBy | NA |
| Beneficiary Nickname | beneficiaryName | requestIn.beneficiaryName | NA |
| Beneficiary Address | NA | NA | NA |
| SupportingDocuments | uploadedattachments | requestIn.uploadedattachments | NA |
| transactionId(Request) | transactionId(Request) | requestIn.transactionId(Request) | NA |
| Reference number(Response) | referenceId(Response) | requestIn.referenceId(Response) | NA |
| Total debit | totalAmount | requestIn.totalAmount | NA |
| Exchange Rate | exchangeRate | requestIn.exchangeRate | NA |
| NA | Overrides(Sepa Cut off Time) | requestIn.Overrides | NA |
| Charges Breakdown | charges | requestIn.charges | NA |
| NA | userId | requestIn.userId | NA |
| NA | validate | requestIn.validate | NA |
| NA | transactionType | requestIn.transactionType | NA |
| NA | beneficiaryAddressLine1 | requestIn.beneficiaryAddressLine1 | NA |
| NA | beneficiaryAddressLine2 | requestIn.beneficiaryAddressLine2 | NA |
| NA | beneficiaryBankName | requestIn.beneficiaryBankName | NA |
| NA | beneficiaryCity | requestIn.beneficiaryCity | NA |
| NA | beneficiarycountry | requestIn.beneficiarycountry | NA |
| NA | beneficiaryEmail | requestIn.beneficiaryEmail | NA |
| NA | beneficiaryNickname | requestIn.beneficiaryNickname | NA |
| NA | beneficiaryPhone | requestIn.beneficiaryPhone | NA |
| NA | beneficiaryZipcode | requestIn.beneficiaryZipcode | NA |
| NA | createWithPaymentId | requestIn.createWithPaymentId | NA |
| NA | deletedDocuments | requestIn.deletedDocuments | NA |
| NA | frequencyEndDate | requestIn.frequencyEndDate | NA |
| NA | beneficiaryState | requestIn.beneficiaryState | NA |
| NA | frequencyStartDate | requestIn.frequencyStartDate | NA |
| NA | iban | requestIn.iban | NA |
| NA | serviceName | requestIn.serviceName | NA |
| NA | toAccountCurrency | requestIn.toAccountCurrency | NA |
| NA | numberOfRecurrences | requestIn.numberOfRecurrences | NA |
| NA | isScheduled | requestIn.isScheduled | NA |
| NA | paymentType | requestIn.paymentType | NA |
| bank Name | NA | requestIn.bank Name | NA |
| addressLine1 | NA | requestIn.addressLine1 | NA |
| countryName | NA | requestIn.countryName | NA |
createCreditCardTransfer
| Description: | This API makes a transfer to credit card. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/CreditCard/createCreditCardTransfer |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Parameters frequencyType Specifies the frequency of the transaction. transactionID Specifies the unique ID of the transaction. transactionType Specifies the type of the transaction. {
"amount": "276.00",
"createWithPaymentId": null,
"transactionId": "",
"frequencyType": "Once",
"fromAccountNumber": "118548",
"isScheduled": "0",
"frequencyStartDate": "2021-04-15T09:42:01.175Z",
"frequencyEndDate": "",
"scheduledDate": "2021-04-15T09:42:01.175Z",
"toAccountNumber": "1901282",
"paymentType": "",
"paidBy": "",
"swiftCode": "",
"serviceName": "TRANSFER_BETWEEN_OWN_ACCOUNT_CREATE",
"beneficiaryNickname": "Freedom Credit",
"transactionsNotes": "",
"transactionType": "InternalTransfer",
"transactionCurrency": "USD",
"fromAccountCurrency": "USD",
"toAccountCurrency": "USD",
"numberOfRecurrences": "",
"ExternalAccountNumber": "",
"uploadedattachments": "",
"deletedDocuments": "",
"transactionAmount": 276,
"serviceCharge": 0,
"charges": "",
"totalAmount": "",
"creditValueDate": ""
}
|
| Response: |
Parameters transactionID Specifies the unique ID of the transaction referenceID Specifies the reference ID of the transaction {
"opstatus": 0,
"message": "Success! Your transaction has been completed",
"referenceId": "122438",
"status": "success",
"httpStatusCode": 0
}
|
| Error Code(s): |
|
| Enterprise Provider: | Temenos Digital |
| Enterprise API: |
{base_url}/services/InfinityTransactionServices/createCreditCardTransfer |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
referenceId |
referenceId |
NA |
NA |
|
amount |
amount |
NA |
NA |
|
fromAccountNumber |
fromAccountNumber |
NA |
NA |
|
frequencyType |
frequencyType |
NA |
NA |
|
frequencyStartDate |
frequencyStartDate |
NA |
NA |
|
scheduledDate |
scheduledDate |
NA |
NA |
|
toAccountNumber |
toAccountNumber |
NA |
NA |
|
serviceName |
serviceName |
NA |
NA |
|
transactionType |
transactionType |
NA |
NA |
|
transactionCurrency |
transactionCurrency |
NA |
NA |
|
fromAccountCurrency |
fromAccountCurrency |
NA |
NA |
|
toAccountCurrency |
toAccountCurrency |
NA |
NA |
|
transactionAmount |
transactionAmount |
NA |
NA |
|
serviceCharge |
serviceCharge |
NA |
NA |
getPurposeCodes
| Description: | This API retrieves all the possible purpose codes and clearing Identifier codes for Transfers. |
| Method: | POST |
| URL: | {base_url}/services/data/v1/TransactionObjects/operations/ExternalCodes/getPurposeCodes |
| Security Level: | Authenticated App Users |
| Header Request: |
X-Kony-Authorization |
| Body Request: |
Purpose Code Request
{
"id":"PurpCd"
}
Clearing Identifier Code Request
{
"id":"ClearingSysId"
}
|
| Response: |
Purpose Code Response
{
"PurposeCodes": [
"BKDF - Bank Loan Delayed Draw Funding",
"BKFE - Bank Loan Fees",
"BKFM - Bank Loan Funding Memo",
"BKIP - Bank Loan Accrued Interest Payment",
"BKPP - Bank Loan Principal Paydown",
"CBLK - Card Bulk Clearing",
"CDCB - Card Payment with CashBack",
"CDCD - Cash Disbursement Cash Settlement",
"CDCS - Cash Disbursement with Surcharging",
"CDDP - Card Deferred Payment",
"CDOC - Original Credit",
"CDQC - Quasi Cash",
"ETUP - E-Purse Top Up",
"FCOL - Fee Collection",
"MTUP - Mobile Top Up",
"ACCT - Account Management",
"CASH - Cash Management Transfer",
"COLL - Collection Payment",
"CSDB - Cash Disbursement Cash Management",
"DEPT - Deposit",
"INTC - Intra Company Payment",
"LIMA - Liquidity Management",
"NETT - Netting",
"BFWD - Bond Forward",
"CCIR - Cross Currency IRS",
"CCPC - CCP Cleared Initial Margin",
"CCPM - CCP Cleared Variation Margin",
"CCSM - CCP Cleared Initial Margin Segregated Cash",
"CRDS - Credit DefaultSwap",
"CRPR - Cross Product",
"CRSP - Credit Support",
"CRTL - Credit Line",
"EQPT - Equity Option",
"EQUS - Equity Swap",
"EXPT - Exotic Option",
"EXTD - Exchange Traded Derivatives",
"FIXI - Fixed Income",
"FWBC - Forward Broker Owned Cash Collateral",
"FWCC - Forward Client Owned Cash Collateral",
"FWSB - Forward Broker Owned Cash Collateral Segregated",
"FWSC - Forward Client Owned Segregated Cash Collateral",
"MARG - Daily margin on listed derivatives",
"MBSB - MBS Broker Owned Cash Collateral",
"MBSC - MBS Client Owned Cash Collateral",
"MGCC - Futures Initial Margin",
"MGSC - Futures Initial Margin Client Owned Segregated Cash Collateral",
"OCCC - Client owned OCC pledged collateral",
"OPBC - OTC Option Broker owned Cash collateral",
"OPCC - OTC Option Client owned Cash collateral",
"OPSB - OTC Option Broker Owned Segregated Cash Collateral",
"OPSC - OTC Option Client Owned Cash Segregated Cash Collateral",
"OPTN - FX Option",
"OTCD - OTC Derivatives",
"REPO - Repurchase Agreement",
"RPBC - Bi-lateral repo broker owned collateral",
"RPCC - Repo client owned collateral",
"RPSB - Bi-lateral repo broker owned segregated cash collateral",
"RPSC - Bi-lateral Repo client owned segregated cash collateral",
"RVPO - Reverse Repurchase Agreement",
"SBSC - Securities Buy Sell Sell Buy Back",
"SCIE - Single Currency IRS Exotic",
"SCIR - Single Currency IRS",
"SCRP - Securities Cross Products",
"SHBC - Broker owned collateral Short Sale",
"SHCC - Client owned collateral Short Sale",
"SHSL - Short Sell",
"SLEB - Securities Lending And Borrowing",
"SLOA - Secured Loan",
"SWBC - Swap Broker owned cash collateral",
"SWCC - Swap Client owned cash collateral",
"SWPT - Swaption",
"SWSB - Swaps Broker Owned Segregated Cash Collateral",
"SWSC - Swaps Client Owned Segregated Cash Collateral",
"TBAS - To Be Announced",
"TBBC - TBA Broker owned cash collateral",
"TBCC - TBA Client owned cash collateral",
"TRCP - Treasury Cross Product",
"AGRT - Agricultural Transfer",
"AREN - Accounts Receivables Entry",
"BEXP - Business Expenses",
"BOCE - Back Office Conversion Entry",
"COMC - Commercial Payment",
"CPYR - Copyright",
"GDDS - Purchase Sale Of Goods",
"GDSV - Purchase Sale Of Goods And Services",
"GSCB - Purchase Sale Of Goods And Services With Cash Back",
"LICF - License Fee",
"MP2B - Mobile P2B Payment",
"POPE - Point of Purchase Entry",
"ROYA - Royalties",
"SCVE - Purchase Sale Of Services",
"SERV - Service Charges",
"SUBS - Subscription",
"SUPP - Supplier Payment",
"TRAD - Commercial",
"CHAR - Charity Payment",
"COMT - Consumer Third Party Consolidated Payment",
"MP2P - Mobile P2P Payment",
"ECPG - Guaranteed EPayment"
],
"opstatus": 0,
"httpStatusCode": 0
}
Clearing Identifier Code Response
{
"PurposeCodes": [
"ATBLZ - Austrian Bankleitzahl",
"AUBSB - Australian Bank State Branch Code BSB",
"CACPA - Canadian Payments Association Payment Routing Number",
"CHBCC - Swiss Financial Institution Identification Short",
"CHSIC - Swiss Financial Institution Identification Long",
"CNAPS - CNAPS Identifier (China)",
"DEBLZ - German Bank leitzahl",
"ESNCC - Spanish Domestic Interbanking Code",
"GBDSC - UK Domestic Sort Code",
"GRBIC - Helenic Bank Identification Code",
"HKNCC - Hong Kong Bank Code",
"IENCC - Irish National Clearing Code",
"INFSC - Indian Financial System Code",
"ITNCC - Italian Domestic Identification Code",
"JPZGN - Japan Zengin Clearing Code",
"NZNCC - New Zealand National Clearing Code",
"PLKNR - Polish National Clearing Code",
"PTNCC - Portuguese National Clearing Code",
"RUCBC - Russian Central Bank Identification Code",
"SESBA - Sweden Bank giro Clearing Code",
"SGIBG - IBG Sort Code (Singapore)",
"THCBC - Thai Central Bank Identification Code",
"TWNCC - Financial Institution Code",
"USABA - United States Routing Number Fedwire NACHA",
"USPID - CHIPS Participant Identifier (US)",
"ZANCC - South African National Clearing Code",
"NZRSA - New Zealand RTGS Clearing Code"
],
"opstatus": 0,
"httpStatusCode": 0
}
|
| Error Code(s): | |
| Enterprise Provider: | Transact |
| Enterprise API: |
Field Mapping
|
UI API field |
Experience API field |
MS API field |
Transact API field |
|---|---|---|---|
|
NA |
NA |
NA |
NA |
Object Data Models
OneTimeTransfer
| Parameter Name | Data Type | Optional / Mandatory | Description |
|---|---|---|---|
|
ExternalAccountNumber |
String |
Mandatory |
It is account Number |
|
amount |
String |
Mandatory |
Credited amount value |
|
beneficiaryNickname |
String |
Optional |
Nick name |
|
createWithPaymentId |
String |
Mandatory |
Payment Id |
|
deletedDocuments |
String |
Optional |
Documents which are deleted |
|
frequencyEndDate |
String |
Mandatory |
End date for a transaction |
|
frequencyStartDate |
String |
Mandatory |
Start date for a transaction |
|
frequencyType |
String |
Mandatory |
Period of a transaction |
|
fromAccountCurrency |
String |
Mandatory |
Type of from account number currency |
|
fromAccountNumber |
String |
Mandatory |
from Account Number |
|
iban |
String |
Optional |
iban number |
|
isScheduled |
String |
Optional |
Transaction time is defined |
|
numberOfRecurrences |
String |
Optional |
Number of recurrences |
|
paidBy |
String |
Mandatory |
Person who paid amount |
|
scheduledDate |
String |
Mandatory |
Date at which transaction occurs |
|
paymentType |
String |
Mandatory |
Type of Payment |
|
toAccountCurrency |
String |
Mandatory |
Type of credited account currency |
|
toAccountNumber |
String |
Mandatory |
credited account number |
|
transactionCurrency |
String |
Mandatory |
Transaction currency type |
|
transactionId |
String |
Mandatory |
Transaction id |
|
transactionType |
String |
Mandatory |
Type of transaction |
|
transactionsNotes |
String |
Optional |
Notes |
|
serviceName |
String |
Mandatory |
Service Name |
|
swiftCode |
String |
Optional |
Swift Code |
|
transactionAmount |
String |
Mandatory |
Transaction Amount |
|
charges |
String |
Optional |
charges |
|
uploadedattachments |
String |
Optional |
Upload attachments |
|
totalAmount |
String |
Mandatory |
Total Amount |
|
creditValueDate |
String |
Mandatory |
Credit Value date |
|
accountID |
String |
Mandatory |
account ID number |
|
principalBalance |
String |
Mandatory |
balance amount |
|
accountName |
String |
Mandatory |
account name |
|
nickName |
String |
Mandatory |
nick name |
|
accountType |
String |
Mandatory |
type of account |
|
dueDate |
String |
Optional |
due date |
|
typeDescription |
String |
Mandatory |
description type |
|
paymentDue |
String |
Optional |
due payment |
|
currencyCode |
String |
Mandatory |
currency code |
|
minimumDue |
String |
Optional |
minimum due |
|
outstandingBalance |
String |
Optional |
outstanding balance |
Transaction
| Parameter Name | Data Type | Optional / Mandatory | Description |
|---|---|---|---|
|
ExternalAccountNumber |
String |
Mandatory |
It is account Number |
|
amount |
String |
Mandatory |
Credited amount value |
|
beneficiaryName |
String |
Mandatory |
beneficiary name |
|
beneficiaryNickname |
String |
Optional |
Nick name |
|
createWithPaymentId |
String |
Mandatory |
Payment Id |
|
deletedDocuments |
String |
Optional |
Documents which are deleted |
|
frequencyEndDate |
String |
Mandatory |
End date for a transaction |
|
frequencyStartDate |
String |
Mandatory |
Start date for a transaction |
|
frequencyType |
String |
Mandatory |
Period of a transaction |
|
fromAccountCurrency |
String |
Mandatory |
Type of from account number currency |
|
fromAccountNumber |
String |
Mandatory |
from Account Number |
|
isScheduled |
String |
Optional |
Transaction time is defined |
|
paidBy |
String |
Mandatory |
Person who paid amount |
|
scheduledDate |
String |
Mandatory |
Date at which transaction occurs |
|
toAccountCurrency |
String |
Mandatory |
Type of credited account currency |
|
toAccountNumber |
String |
Mandatory |
credited account number |
|
transactionCurrency |
String |
Mandatory |
Transaction currency type |
|
transactionId |
String |
Mandatory |
Transaction id |
|
transactionType |
String |
Mandatory |
Type of transaction |
|
transactionsNotes |
String |
Optional |
Notes |
|
uploadedattachments |
|
Optional |
attachments |
|
beneficiaryAddressLine1 |
String |
Mandatory |
Address |
|
beneficiaryAddressLine2 |
String |
Optional |
Address |
|
beneficiaryBankName |
String |
Mandatory |
Bank Name of Beneficiary |
|
beneficiaryCity |
String |
Optional |
City name |
|
beneficiarycountry |
String |
Optional |
Country name |
|
beneficiaryEmail |
String |
Optional |
Email id |
|
beneficiaryPhone |
String |
Optional |
Phone number |
|
beneficiaryState |
String |
Optional |
State |
|
beneficiaryZipcode |
String |
Optional |
Zip Code Number |
|
clearingCode |
String |
Optional |
Clearing code number |
|
e2eReference |
String |
Optional |
e2e Reference number |
|
iban |
String |
Optional |
iban number |
|
intermediaryBicCode |
String |
Optional |
Bic code number |
|
numberOfRecurrences |
String |
Optional |
Number of recurrences |
|
paymentType |
String |
Mandatory |
Type of Payment |
|
serviceName |
String |
Mandatory |
Service Name |
|
swiftCode |
String |
Optional |
Swift Code |
|
userId |
String |
Optional |
User Id |
|
transactionAmount |
String |
Mandatory |
Transaction Amount |
|
charges |
String |
Optional |
charges |
|
exchangeRate |
String |
Optional |
Exchange Rate |
|
totalAmount |
String |
Mandatory |
Total Amount |
|
creditValueDate |
String |
Mandatory |
Credit Value date |
|
toAccountName |
String |
Mandatory |
To Account Person Name |
|
validate |
String |
Mandatory |
validation status |
|
beneficiaryId |
String |
Mandatory |
Beneficiary Id |
|
personId |
String |
Mandatory |
Person Id |
|
messageDetails |
string |
Mandatory |
Message Details |
|
referenceId |
string |
Mandatory |
Reference Id |
|
overrides |
string |
Mandatory |
Overrides |
|
serviceCharge |
string |
Mandatory |
Service Charge |
|
message |
string |
Mandatory |
message |
|
status |
string |
Mandatory |
status |
|
description |
string |
Mandatory |
description |
|
fromAccountName |
string |
Mandatory |
Credit account person name |
|
transactionDate |
string |
Mandatory |
Transaction Date |
|
payeeCurrency |
string |
Mandatory |
Payee Currency |
|
statusDescription |
string |
Mandatory |
Description of status |
|
pendingApproval |
string |
Mandatory |
Pending Approval |
|
beneficaryName |
string |
Mandatory |
Beneficiary name |
|
softdeleteflag |
string |
Mandatory |
flag status |
|
firstRecordNumber |
string |
Mandatory |
firstRecordNumber |
|
lastRecordNumber |
string |
Mandatory |
lastRecordNumber |
|
sortBy |
string |
Mandatory |
sortBy |
|
order |
string |
Mandatory |
order |
BankDetails
| Parameter Name | Data Type | Optional / Mandatory | Description |
|---|---|---|---|
|
city |
string |
Mandatory |
City name |
|
bankName |
string |
Mandatory |
Bank name |
|
country |
string |
Mandatory |
Country name |
|
iban |
string |
Mandatory |
IBAN number |
|
bic |
string |
Mandatory |
bic value |
|
id |
string |
Mandatory |
id number |
|
sepaMember |
string |
Mandatory |
is sepa member |
|
countryCode |
string |
Mandatory |
Country code |
|
addressLine1 |
string |
Mandatory |
address |
|
isBICValid |
string |
Mandatory |
is the bic is valid |
|
countryName |
string |
Mandatory |
country name |
|
status |
string |
Mandatory |
status |
|
errmsg |
string |
Mandatory |
error message |
|
isIBANValid |
string |
Mandatory |
is IBAN valid |
Payees
| Parameter Name | Data Type | Optional / Mandatory | Description |
|---|---|---|---|
| accountNumber | string | Mandatory | Account number |
| isSameBankAccount | string | Mandatory | Is same bank account |
| isVerified | string | Mandatory | Is verified |
| nickName | string | Mandatory | Nick name |
| swiftCode | string | Mandatory | Swift code |
| IBAN | string | Mandatory | IBAN |
| coreCustomerId | string | Mandatory | Core customer id |
| contractId | string | Mandatory | Contract ID |
| Id | string | Mandatory | ID number |
| noOfCustomersLinked | string | Mandatory | Number of linked customers |
In this topic