Temenos Digital
R24 AMR | Min(s) read

Bulk Wire Template

The Wire transfer feature allows a user to transfer money from one bank (credit union) to another using a network such as SWIFT. Similarly, a Bulk Wire Transfer involves uploading multiple wire transfers in a single instance. To perform a Bulk Wire Transfer the user must create a Bulk Wire template that contains a list of recipients. By using this template, the user can transfer the amount to multiple people at once. Bulk Payment feature is common to both Retail Banking and SME Banking.

For more information on Bulk Wire Transfer, refer to the Temenos Digital Documentation.

Name Description Introduced In
CreateBulkWireTemplate This API allows the user to create a new bulk wire template and also the recipients of the template. This template contains multiple recipients. and by using the template the user can transfer the amount to all the recipients at once. This template can be reused multiple times. 2020.07
UpdateBulkWireTemplate This API allows the user to update an existing bulk wire template and the recipients that belong to the template. 2020.07
DeleteBulkWireTemplateRecipient This API allows the user to delete a recipient from an existing bulk wire template. 2020.07
DeleteBulkWireTemplate This API allows the user to delete an existing Bulk Wire Template 2020.07
getUnselectedPayeesForBWTemplate This API allows the user to fetch all the payees that are not selected in the specified template. 2020.07
getBulkWiresForUser This API allows the user to fetch all the Bulk wire templates and files that are accessible to the logged-in user. 2020.07
getBulkwireFileLineItems This API allows the user to fetch the line items(recipients) for a given Bulk wire template. 2020.07
CreateBulkWireTransfer This API allows the user to perform wire transfer by using the Bulk Wire template. The Bulk Wire template contains the details of all the recipients that are required for placing a Bulk Wire transfer request. 2020.07
getTransactionsByBulkWireTemplateExecutionId This API allows the user to fetch the details of all the wire transactions that were executed during a Bulk Wire Transfer. The user must provide the ExecutionId as an input request to fetch all the corresponding wire transfer details. 2020.07
getBulkWireTemplateTransactionDetail This API allows the user to fetch the details of all the Bulk Wire transfers that were executed by using a Bulk Wire template. The user must provide the TemplateId as an input request to fetch all the corresponding bulk wire transfer details. 2020.07
uploadBWFile This API allows the user to extract and return the recipient and recipient details from a Bulk Wire Template/Bulk Wire file. 2020.07
initiateDownloadBulkWireSampleFile This API allows the user to download the sample file for Bulk Wire Template / Bulk Wire File based on the input request provided by the user. 2020.07
getBulkWireTemplateLineItems This API allows the user to retrieve bulk wire template line items. 2021.10
getBulkWireFileTransactionDetail This API allows the user to fetch the transaction details from a bulk wire file. 2020.04
getTransactionsByBulkWireFileExecutionId This API allows the user to fetch the execution details of the bulk wire transaction. 2020.04
Object Data Models This Object Data Model describes the parameter name and other attribute details for Bulk Wire Template.  
 
Description: This API allows the user to create a new bulk wire template and also the recipients of the template. This template contains multiple recipients. and by using the template the user can transfer the amount to all the recipients at once. This template can be reused multiple times.
Method: POST
URL: {base_url}//services/data/v1/BulkWireObjects/operations/BulkWire/CreateBulkWireTemplate
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

defaultFromAccount (Mandatory)

Specifies the default account for the bulk wire transfer.

defaultCurrency (Mandatory)

Specifies the default currency for bulk wire transfer.

bulkWireTemplateName (Mandatory)

Specifies the name of the bulk wire template.

bulkWireTransferType (Mandatory)

Specifies the type of bulk wire transfer.

transactionType (Mandatory)

Specifies the type of transaction.

routingNumber (Mandatory)

Specifies the routing number of the bank.

accountNickname (Mandatory)

Specifies the nick name of the account.

recipientAccountNumber (Mandatory)

Specifies the recipient account number.

recipientName (Mandatory)

Specifies the name of the recipient.

recipientAddressLine1 (Mandatory)

Specifies the first line of address recipient.

recipientAddressLine2

Specifies the second line of address recipient.

recipientCity (Mandatory)

Specifies the city name of the recipient.

recipientState (Mandatory)

Specifies the state of the recipient.

recipientZipCode (Mandatory)

Specifies the zip code of the recipient.

recipientID (Mandatory)

Specifies the unique recipient ID.

isDeleted (Mandatory)

Specifies whether template is deleted or not.

recipientBankName (Mandatory)

Specifies the bank name of the recipient.

recipientBankAddress1 (Mandatory)

Specifies the first line of recipient bank address.

recipientBankAddress2

Specifies the second line of recipient bank address.

recipientBankcity (Mandatory)

Specifies the recipient bank city.

recipientBankstate (Mandatory)

Specifies the recipient bank state.

recipientBankZipCode (Mandatory)

Specifies the recipient bank zip code.

payeeId (Mandatory)

Specifies the unique payee ID.

templateRecipientCategory (Mandatory)

Specifies the category of the recipient.

{
    "defaultFromAccount": "118567",
    "defaultCurrency": "USD",
    "bulkWireTemplateName": "nick",
    "Recipients": [{
        "recipientName": "dgfnick",
        "recipientAddressLine1": "recipientAddressLine11",
        "recipientAddressLine2": "recipientAddressline21",
        "recipientCity": "Hyderabad",
        "recipientState": "Ordino",
        "recipientZipCode": "500081",
        "recipientAccountNumber": "1234536",
        "accountNickname": "accountNickname1",
        "recipientBankName": "recipientBank1",
        "recipientBankAddress1": "Bankaddress1",
        "recipientBankAddress2": "bankaddressline21",
        "recipientBankcity": "Hyderabad",
        "recipientBankstate": "Ordino",
        "recipientBankZipCode": "500042",
        "bulkWireTransferType": "Domestic",
        "transactionType": "Individual",
        "routingNumber": "985678",
        "payeeId": "26911283",
        "recipientID": "a5jhqmnql",
        "isDeleted": false,
        "templateRecipientCategory": "EXISTINGRECIPIENT"
    }, {
        "recipientName": "nickel",
        "recipientAddressLine1": "adress",
        "recipientAddressLine2": "1234",
        "recipientCity": "banglore",
        "recipientState": "",
        "recipientZipCode": "1234",
        "recipientAccountNumber": "989898",
        "accountNickname": "nickel",
        "recipientBankName": "HDFC",
        "recipientBankAddress1": "bankd",
        "recipientBankAddress2": "address",
        "recipientBankcity": "banglore",
        "recipientBankstate": "",
        "recipientBankZipCode": "1234",
        "bulkWireTransferType": "Domestic",
        "transactionType": "Individual",
        "routingNumber": "123443",
        "payeeId": "66140646",
        "recipientID": "bd9o5ne0e",
        "isDeleted": false,
        "templateRecipientCategory": "EXISTINGRECIPIENT"
    }]
}
Response:

Parameters

noOfTransactions (Mandatory)

Specifies the number of transactions.

bulkWireTemplateID (Mandatory)

Specifies the unique bulk wire template ID.
noOfDomesticTransactions (Mandatory)

Specifies the total number of domestic transactions.

defaultCurrency (Mandatory)

Specifies the default currency for the wire transfer.

defaultFromAccount (Mandatory)

Specifies the default account for the wire transfer.

noOfInternationalTransactions (Mandatory)

Specifies the total number of international wire transactions.
lastmodifiedts (Mandatory)

Specifies the time stamp of last modified date.

bulkWireTemplateName (Mandatory)

Specifies the name of the bulk wire template.

createdts (Mandatory)

Specifies the time stamp of the created date.

{
    "lastmodifiedts": "2021-09-24T20:36:34Z",
    "bulkWireTemplateID": "le6rkRLY-LenmaP6B-OejRlnZl-EretumjI",
    "noOfTransactions": 2,
    "noOfDomesticTransactions": 2,
    "defaultCurrency": "USD",
    "defaultFromAccount": "118567",
    "noOfInternationalTransactions": 0,
    "bulkWireTemplateName": "nick",
    "createdts": "2021-09-24T20:36:34Z",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/CreateBulkWireTemplate

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireTemplateID

bulkWireTemplateID

NA

NA

lastmodifiedts

lastmodifiedts

NA

NA

noOfTransactions

noOfTransactions

NA

NA

noOfDomesticTransactions

noOfDomesticTransactions

NA

NA

defaultCurrency

defaultCurrency

NA

NA

defaultFromAccount

defaultFromAccount

NA

NA

noOfInternationalTransactions

noOfInternationalTransactions

NA

NA

bulkWireTemplateName

bulkWireTemplateName

NA

NA

createdts

createdts

NA

NA
 
Description: This API allows the user to update an existing bulk wire template and the recipients that belong to the template.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWire/UpdateBulkWireTemplate
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateID(Mandatory)

Specifies the unique bulk wire template ID.

bulkWireTemplateName(Mandatory)

Specifies the name of the bulk wire template.

defaultFromAccount(Mandatory)

Specifies the default account for bulk wire transfer.

defaultCurrency(Mandatory)

Specifies the default currency for bulk wire transfer.

{
    "bulkWireTemplateID": "le6rkRLY-LenmaP6B-OejRlnZl-EretumjI",
    "bulkWireTemplateName": "nick",
    "defaultFromAccount": "118567",
    "defaultCurrency": "EUR",
    "Recipients": []
}
Response:

Parameters

lastmodifiedts(Mandatory)

Specifies the last modified time stamp of bulkwiretemplate..

bulkWireTemplateID(Mandatory)

Specifies the unique bulk wire template.

noOfTransactions (Mandatory)

Specifies the number of transactions for the bulk wire template.

noOfDomesticTransactions(Mandatory)

Specifies the number of domestic transactions for the bulk wire template.

defaultCurrency(Mandatory)

Specifies the default currency for the transaction.

defaultFromAccount(Mandatory)

Specifies the default account from where the amount gets debited.

noOfInternationalTransactions(Mandatory)

Specifies the total number of international transactions for the bulk wire template.

bulkWireTemplateName(Mandatory)

Specifies the name of the bulk wire template.

createdts(Mandatory)

Specifies the created date time stamp of the bulk wire template.
{
    "lastmodifiedts": "2021-09-24T20:44:45Z",
    "bulkWireTemplateID": "le6rkRLY-LenmaP6B-OejRlnZl-EretumjI",
    "noOfTransactions": 2,
    "noOfDomesticTransactions": 2,
    "defaultCurrency": "EUR",
    "defaultFromAccount": "118567",
    "noOfInternationalTransactions": 0,
    "bulkWireTemplateName": "nick",
    "createdts": "2021-09-24T20:36:34Z",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}0/services/dbpBulkWireServices/UpdateBulkWireTemplate

Field Mapping

UI field Experience API field MS  API field Transact API field

lastmodifiedts

lastmodifiedts

NA

NA

bulkWireTemplateID

bulkWireTemplateID

NA

NA

noOfTransactions

noOfTransactions

NA

NA

noOfDomesticTransactions

noOfDomesticTransactions

NA

NA

defaultCurrency

defaultCurrency

NA

NA

defaultFromAccount

defaultFromAccount

NA

NA

noOfInternationalTransactions

noOfInternationalTransactions

NA

NA

bulkWireTemplateName

bulkWireTemplateName

NA

NA

createdts

createdts

NA

NA
 
Description: This API allows the user to delete a recipient from an existing bulk wire template.
Method: POST
URL: {base_url}/BulkWireObjects/operations/BulkWire/DeleteBulkWireTemplateRecipient
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateId

Specifies the unique ID of the Bulk Wire template from where the recipient must be removed.

Recipients

Specifies an array of recipients. These recipients must be removed from the template

Recipients/bulkWireTemplateLineItemID

Specifies the unique line Item ID of the Bulk Wire template. Based on the ID value the corresponding recipient gets deleted.

{
   "bulkWireTemplateID":"1IFcQTTZ-XxbNzurQ-2Q61CD9p-m8tPpzlB",
   "Recipients":[
      {
         "bulkWireTemplateLineItemID":"32"
      },
      {
         "bulkWireTemplateLineItemID":"33"
      }
   ]
}
Response:

Parameters

/noOfTransactions

Specifies the number of transactions performed by the customer.

/noOfDomesticTransactions

Specifies the number of domestic transactions performed by the customer.

/noOfInternationalTransactions

Specifies the number of international transactions performed by the customer.

/bulkWireTemplateName

Specifies the name of the Bulk Wire template from where the recipient was deleted.

/defaultFromAccount

Specifies the default account from where the amount gets debited.

/company_id

Specifies the unique ID of the company/organization.

/defaultCurrency

Specifies the default currency that is used while performing transactions.

/bulkWireTemplateID

Specifies the unique ID of the Bulk Wire template from which the recipient got removed.

{
   "noOfTransactions":"1",
   "noOfDomesticTransactions":"1",
   "noOfInternationalTransactions":"0",
   "bulkWireTemplateName":" Template Name Updated",
   "defaultFromAccount":"123467",
   "company_id":"123",
   "defaultCurrency":"USD",
   "bulkWireTemplateID":"1IFcQTTZ-XxbNzurQ-2Q61CD9p-m8tPpzlB ",
   "opstatus":0,
   "httpStatusCode":0
}
Error Code(s):
  • Error Code: 12000
    Error Message: Internal Service Error
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
 
Description: This API allows the user to delete an existing Bulk Wire Template
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWire/DeleteBulkWireTemplate
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateID (Mandatory)

Specifies the unique ID of the Bulk Wire template

{
    "bulkWireTemplateID": "PpK5QLn8-KjJb5RsW-cwM1d9VQ-Rn2wlafT"
}
Response: 
{
    "Success": "BulkWireTemplate has been successfully deleted",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/DeleteBulkWireTemplate

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireTemplateID

bulkWireTemplateID

NA

NA

Success

Success

NA

NA
 
Description: This API allows the user to fetch all the payees that are not selected in the specified template.
Method: POST
URL: /BulkWireObjects/operations/BulkWire/ GetUnselectedPayeesForBWTemplate
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

Parameters

/UnSelectedPayees

Specifies an array of payees that got removed from the selected list and their corresponding details.

/UnSelectedPayees/name

Specifies the name of the payee.

/UnSelectedPayees/accountNumber

Specifies the account number of the payee.

/UnSelectedPayees/companyName

Specifies the name of the company/organization.

/UnSelectedPayees/phone

Specifies the phone number of the payee.

/UnSelectedPayees/email

Specifies the email ID of the payee.

/UnSelectedPayees/firstName

Specifies the first name of the payee.

/UnSelectedPayees/lastName

Specifies the last name of the payee.

/UnSelectedPayees/cityName

Specifies the name of the city in which the payee resides.

/UnSelectedPayees/state

Specifies the name of the state in which the payee resides.

/UnSelectedPayees/addressLine1

Specifies the first line of address of the payee.

/UnSelectedPayees/addressLine2

Specifies the second line of address of the payee.

/UnSelectedPayees/zipCode

Specifies the zipcode.

/UnSelectedPayees/nickName

Specifies the nickname of the payee.

/UnSelectedPayees/softDelete

Specifies whether the soft delete feature is enabled or not for the Payees In Quantum Fabric. The values are Boolean.

/UnSelectedPayees/billermaster_id

Specifies the unique ID of the authorized biller.

/UnSelectedPayees/isAutoPayEnabled

Specifies whether the Auto-Pay feature of the Temenos Digital application is enabled or not. The values are Boolean.

/UnSelectedPayees/nameOnBill

Specifies the name of the payee on the bill.

/UnSelectedPayees/isWiredRecepient

Specifies whether the payee is a wired recipient or not. The values are Boolean.

/UnSelectedPayees/isManuallyAdded

Specifies whether the payee has been manually added to the Bulk Wire template. The values are Boolean.

{"UnSelectedPayees":[
   {
      "name":"CitiBank Credit Cards",
      "accountNumber":"6890396982929",
      "companyName":"CitiBank Credit Cards",
      "phone":"1273981272",
      "email":"citiBank@gmail.com",
      "firstName":"Citi",
      "lastName":"Card",
      "cityName":"Orlando",
      "state":"Florida",
      "addressLine1":"CITI Business",
      "addressLine2":"15 Boltonfield St",
      "zipCode":"759634",
      "nickName":"Citi Credit Card",
      "softDelete":"false",
      "billermaster_id":"1",
      "isAutoPayEnabled":"false",
      "nameOnBill":"John Bailey",
      "isWiredRecepient":"true",
      "isManuallyAdded":"false"
   },
   {
      "name":"CitiBank Dedit Cards",
      "accountNumber":"6890396982928",
      "companyName":"CitiBank Dedit Cards",
      "phone":"1273981272",
      "email":"citiBank@gmail.com",
      "firstName":"Citi",
      "lastName":"Card",
      "cityName":"Orlando",
      "state":"Florida",
      "addressLine1":"CITI Business",
      "addressLine2":"15 Boltonfield St",
      "zipCode":"759634",
      "nickName":"CitiBank Dedit Cards",
      "softDelete":"false",
      "billermaster_id":"1",
      "isAutoPayEnabled":"false",
      "nameOnBill":"John Bailey",
      "billerId":"1",
      "isWiredRecepient":"true",
      "isManuallyAdded":"false"
   }
],
"opstatus":0,
"httpStatusCode":0
}
Error Code(s):
  • Error Code: 12000
    Error Message: Internal Service Error
  • Error Code: 12001
    Error Message: Logged in User is not authorized to perform this action
 
Description: This API allows the user to fetch all the Bulk wire templates and files that are accessible to the logged-in user.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWire/getBulkWiresForUser
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

bulkWireCategoryFilter (Mandatory)

Specifies the category for bulk wire filter.

{
    "pageOffset": 0,
    "pageSize": 10,
    "bulkWireCategoryFilter": "Templates"
}
Response:

Parameters

bulkWireID (Mandatory)

Specifies the unique bulk wire.

bulkWireName (Mandatory)

Specifies the name of the bulk wire.
noOfTransactions (Mandatory)

Specifies the total number of transactions.

noOfDomesticTransactions (Mandatory)

Specifies the total number of Domestic transactions.

noOfInternationalTransactions (Mandatory)

Specifies the total number of International transactions.

createdts (Mandatory)

Specifies the time stamp of created date.
lastmodifiedts (Mandatory)

Specifies the time stamp of last modified date.

lastExecutedOn (Mandatory)

Specifies the time stamp of the last executed date.

firstname (Mandatory)

Specifies the first name.

lastname (Mandatory)

Specifies the last name.
defaultFromAccount (Mandatory)

Specifies the default account for the wire transfer.

defaultCurrency (Mandatory)

Specifies the default currency for the wire transfer.

bulkWireCategory (Mandatory)

Specifies the category for the bulk wire.

{
    "BulkWires": [{
        "bulkWireID": "ZRzRSG2X-MlHcJYMO-qWjdZKgM-yk4eCX5x",
        "bulkWireName": "userrat",
        "noOfTransactions": "3",
        "noOfDomesticTransactions": "3",
        "noOfInternationalTransactions": "0",
        "createdts": "2021-09-01T21:13:59Z",
        "lastmodifiedts": "2021-09-01T21:13:59Z",
        "lastExecutedOn": "2021-09-01T10:57:26Z",
        "firstname": "Temenos",
        "lastname": "Temenos",
        "defaultFromAccount": "131644",
        "defaultCurrency": "GBP",
        "bulkWireCategory": "Templates"
    }, {
        "bulkWireID": "6TFgsPSo-tJcbCDf5-a0EdgANT-JOMtR4j2",
        "bulkWireName": "bulk",
        "noOfTransactions": "1",
        "noOfDomesticTransactions": "1",
        "noOfInternationalTransactions": "0",
        "createdts": "2021-09-01T21:05:32Z",
        "lastmodifiedts": "2021-09-01T21:05:32Z",
        "firstname": "Temenos",
        "lastname": "Temenos",
        "defaultFromAccount": "131644",
        "defaultCurrency": "GBP",
        "bulkWireCategory": "Templates"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getBulkWiresForUser

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireID

bulkWireID

NA

NA

bulkWireName

bulkWireName

NA

NA

noOfTransactions

noOfTransactions

NA

NA

noOfDomesticTransactions

noOfDomesticTransactions

NA

NA

noOfInternationalTransacti

noOfInternationalTransacti

NA

NA

createdts

createdts

NA

NA

lastmodifiedts

lastmodifiedts

NA

NA

lastExecutedOn

lastExecutedOn

NA

NA

firstname

firstname

NA

NA

defaultFromAccountdefaultFromAccount

defaultFromAccountdefaultFromAccount

NA

NA

defaultFromAccount

defaultFromAccount

NA

NA
 
Description: This API allows the user to fetch the line items(recipients) for a given Bulk wire template.
Method: POST
URL: {base_url}/BulkWireObjects/operations/BulkWire/getBulkwireFileLineItems
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateID(Mandatory)

Specifies the unique ID of the Bulk Wire Template. Based on the ID the line items of the respective template are fetched.

sortBy

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

{
    "bulkWireFileID": "tO0q6JNz-oiLa3ttI-IUnsyhAV-GKA0Ocu5",
    "sortBy": "",
    "pageOffset": 0,
    "pageSize": 10,
    "searchString": ""
}
Response:

View the Response Parameters

Parameters

recipientBankAddress1(Mandatory)

Specifies the first line of recipient bank address.

recipientBankAddress2(Mandatory)

Specifies the second line of recipient bank address.

recipientZipCode(Mandatory)

Specifies the recipient zip code.

fromAccountNumber(Mandatory)

Specifies the recipient account number.

note(Mandatory)

Specifies the note for the template.

swiftCode(Mandatory)

Specifies the swift code for the transaction.

recipientName(Mandatory)

Specifies the name of the recipient.

recipientBankName(Mandatory)

Specifies the recipient bank name.

bulkWireFileLineItemID(Mandatory)

Specifies the unique bulkWireFileLineItemID.

recipientState(Mandatory)

Specifies the state of recipient.

bulkWireTransferType(Mandatory)

Specifies the type of transfer.

transactionType(Mandatory)

Specifies the type of transaction.

amount(Mandatory)

Specifies the amount.

currency(Mandatory)

Specifies the name of the currency for the bulk wire transactions.

recipientBankstate(Mandatory)

Specifies the recipient state name in which bank is present.

recipientAddressLine1(Mandatory)

Specifies the first line of recipient bank address.

recipientAddressLine2(Mandatory)

Specifies the second line of recipient bank address.

recipientBankZipCode(Mandatory)

Specifies the zip code of recipient bank

recipientBankcity(Mandatory)

Specifies the city name of recipient bank

recipientAccountNumber(Mandatory)

Specifies the account number of the recipient.

routingNumber(Mandatory)

Specifies the routing number.

recipientCountryName(Mandatory)

Specifies the country name of the recipient.

internationalRoutingNumber(Mandatory)

Specifies the international routing number.

{
    "BulkWireFileLineItems": [{
        "Domestic": [{
            "recipientBankAddress1": "Bankaddress2",
            "recipientBankAddress2": "bankaddressline22",
            "recipientZipCode": "500081",
            "fromAccountNumber": "118567",
            "note": "2nd records",
            "swiftCode": "abc124",
            "recipientName": "wer",
            "recipientBankName": "recipientBank2",
            "recipientCity": "Hyderabad",
            "bulkWireFileLineItemID": "9",
            "recipientState": "Telangana",
            "bulkWireTransferType": "Domestic",
            "transactionType": "Business",
            "amount": "2.34",
            "currency": "GBP",
            "recipientBankstate": "Telangana",
            "recipientAddressLine1": "recipientAddressLine12",
            "recipientAddressLine2": "recipientAddressline22",
            "recipientBankZipCode": "500042",
            "recipientBankcity": "Hyderabad",
            "recipientAccountNumber": "1234537",
            "routingNumber": "98568",
            "recipientCountryName": "India",
            "internationalRoutingNumber": "456183"
        }],
        "International": [{
            "recipientBankAddress1": "Bankaddress1",
            "recipientBankAddress2": "bankaddressline21",
            "recipientZipCode": "500081",
            "fromAccountNumber": "118567",
            "note": "1st records",
            "swiftCode": "abc123",
            "recipientName": "dgf",
            "recipientBankName": "recipientBank1",
            "recipientCity": "Hyderabad",
            "bulkWireFileLineItemID": "11",
            "recipientState": "Telangana",
            "bulkWireTransferType": "International",
            "transactionType": "Individual",
            "amount": "1.22",
            "currency": "USD",
            "recipientBankstate": "Telangana",
            "recipientAddressLine1": "recipientAddressLine11",
            "recipientAddressLine2": "recipientAddressline21",
            "recipientBankZipCode": "500042",
            "recipientBankcity": "Hyderabad",
            "recipientAccountNumber": "1234536",
            "routingNumber": "98567",
            "recipientCountryName": "India",
            "internationalRoutingNumber": "456182"
        }, {
            "recipientBankAddress1": "Bankaddress3",
            "recipientBankAddress2": "bankaddressline23",
            "recipientZipCode": "500081",
            "fromAccountNumber": "118567",
            "note": "3rd records",
            "swiftCode": "abc125",
            "recipientName": "ewr",
            "recipientBankName": "recipientBank3",
            "recipientCity": "Hyderabad",
            "bulkWireFileLineItemID": "10",
            "recipientState": "Telangana",
            "bulkWireTransferType": "International",
            "transactionType": "Individual",
            "amount": "1.22",
            "currency": "INR",
            "recipientBankstate": "Telangana",
            "recipientAddressLine1": "recipientAddressLine13",
            "recipientAddressLine2": "recipientAddressline23",
            "recipientBankZipCode": "500042",
            "recipientBankcity": "Hyderabad",
            "recipientAccountNumber": "1234538",
            "routingNumber": "98569",
            "recipientCountryName": "India",
            "internationalRoutingNumber": "456184"
        }, {
            "recipientBankAddress1": "Bankaddress5",
            "recipientBankAddress2": "bankaddressline25",
            "recipientZipCode": "500081",
            "fromAccountNumber": "118567",
            "note": "5th records",
            "swiftCode": "abc127",
            "recipientName": "ewr",
            "recipientBankName": "recipientBank5",
            "recipientCity": "Hyderabad",
            "bulkWireFileLineItemID": "12",
            "recipientState": "Telangana",
            "bulkWireTransferType": "International",
            "transactionType": "Individual",
            "amount": "1.22",
            "currency": "EUR",
            "recipientBankstate": "Telangana",
            "recipientAddressLine1": "recipientAddressLine15",
            "recipientAddressLine2": "recipientAddressline25",
            "recipientBankZipCode": "500042",
            "recipientBankcity": "Hyderabad",
            "recipientAccountNumber": "1234540",
            "routingNumber": "98571",
            "recipientCountryName": "India",
            "internationalRoutingNumber": "456186"
        }]
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getBulkWireFileLineItems

Field Mapping

UI field Experience API field MS  API field Transact API field

recipientBankAddress1

recipientBankAddress1

NA

NA

recipientBankAddress2

recipientBankAddress2

NA

NA

recipientZipCode

recipientZipCode

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

note

note

NA

NA

swiftCode

swiftCode

NA

NA

recipientName

recipientName

NA

NA

recipientBankName

recipientBankName

NA

NA

recipientCity

recipientCity

NA

NA

bulkWireFileLineItemID

bulkWireFileLineItemID

NA

NA

recipientState

recipientState

NA

NA

bulkWireTransferType

bulkWireTransferType

NA

NA

transactionType

transactionType

NA

NA

amount

amount

NA

NA

currency

currency

NA

NA

recipientBankstate

recipientBankstate

NA

NA

recipientAddressLine1

recipientAddressLine1

NA

NA

recipientAddressLine2

recipientAddressLine2

NA

NA

recipientBankZipCode

recipientBankZipCode

NA

NA

recipientBankcity

recipientBankcity

NA

NA

recipientAccountNumber

recipientAccountNumber

NA

NA

routingNumber

routingNumber

NA

NA

recipientCountryName

recipientCountryName

NA

NA

internationalRoutingNumber

internationalRoutingNumber

NA

NA
 
Description: This API allows the user to perform wire transfer by using the Bulk Wire template. The Bulk Wire template contains the details of all the recipients that are required for placing a Bulk Wire transfer request.
Method: POST
URL: {base_url}/services/data/v1/TransactionObjects/operations/Transaction/CreateBulkWireTransfer
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

bulkPayString (Mandatory)

Specifies the string name.

fromAccountNumber (Mandatory)

Specifies the nick name of the account.

amount (Mandatory)

Specifies the amount.

transactionType (Mandatory)

Specifies the transaction type.

payeeNickName (Mandatory)

Specifies the nick name of the payee.

payeeAccountNumber (Mandatory)

Specifies the account number of the payee.

payeeAddressLine1 (Mandatory)

Specifies the first line of address of the payee.

payeeAddressLine2

Specifies the second line of address of the payee.

payeeName (Mandatory)

Specifies the name of the payee.

payeeCurrency (Mandatory)

Specifies the currency for the payee.

wireAccountType (Mandatory)

Specifies type of the wire account.

country (Mandatory)

Specifies the country of the payee.

bankName (Mandatory)

Specifies the name of the bank.

zipCode (Mandatory)

Specifies the zip code of the payee.

cityName (Mandatory)

Specifies the name of the city.

state (Mandatory)

Specifies the state of the payee.

bankAddressLine1 (Mandatory)

Specifies the first line of bank address.

bankAddressLine2

Specifies the second line of bank address.

bankCity (Mandatory)

Specifies the city of the bank.

bankState (Mandatory)

Specifies the state of the bank.

payeeType (Mandatory)

Specifies the type of the payee.

routingNumber (Mandatory)

Specifies the routing number of the payee.

payeeId (Mandatory)

Specifies the unique payee ID.

{
    "bulkPayString": "{\"bulkWireTemplateID\":\"Q1ZF2D17-Rc2inQBp-wYA5xbdi-rRoUHhN2\",\"bulkWireName\":\"Test Template 2\",\"bulkWireType\":\"Template\",\"totalCountOfTransactions\":3,\"totalCountOfDomesticTransactions\":3,\"totalCountOfInternationalTransactions\":0,\"BWrecords\":[{\"fromAccountNumber\":\"118656\",\"amount\":\"1\",\"transactionType\":\"Wire\",\"payeeNickName\":\"accountNickname1\",\"payeeAccountNumber\":\"1234536\",\"payeeAddressLine1\":\"recipientAddressLine11\",\"payeeAddressLine2\":\"recipientAddressline21\",\"payeeName\":\"dgf\",\"payeeCurrency\":\"£\",\"wireAccountType\":\"Domestic\",\"country\":\"India\",\"bankName\":\"recipientBank1\",\"zipCode\":\"500081\",\"cityName\":\"Hyderabad\",\"state\":\"Telangana\",\"bankAddressLine1\":\"Bankaddress1\",\"bankAddressLine2\":\"bankaddressline21\",\"bankCity\":\"Hyderabad\",\"bankState\":\"Telangana\",\"payeeType\":\"Individual\",\"routingNumber\":\"98567\"},{\"fromAccountNumber\":\"118656\",\"amount\":\"1\",\"transactionType\":\"Wire\",\"payeeNickName\":\"accountNickname3\",\"payeeAccountNumber\":\"1234538\",\"payeeAddressLine1\":\"recipientAddressLine13\",\"payeeAddressLine2\":\"recipientAddressline23\",\"payeeName\":\"ewr\",\"payeeCurrency\":\"£\",\"wireAccountType\":\"Domestic\",\"country\":\"India\",\"bankName\":\"recipientBank3\",\"zipCode\":\"500081\",\"cityName\":\"Hyderabad\",\"state\":\"Telangana\",\"bankAddressLine1\":\"Bankaddress3\",\"bankAddressLine2\":\"bankaddressline23\",\"bankCity\":\"Hyderabad\",\"bankState\":\"Telangana\",\"payeeType\":\"Individual\",\"routingNumber\":\"98569\"},{\"fromAccountNumber\":\"118656\",\"amount\":\"1\",\"transactionType\":\"Wire\",\"payeeNickName\":\"accountNickname5\",\"payeeAccountNumber\":\"1234540\",\"payeeAddressLine1\":\"recipientAddressLine15\",\"payeeAddressLine2\":\"recipientAddressline25\",\"payeeName\":\"ewr\",\"payeeCurrency\":\"£\",\"wireAccountType\":\"Domestic\",\"country\":\"India\",\"bankName\":\"recipientBank5\",\"zipCode\":\"500081\",\"cityName\":\"Hyderabad\",\"state\":\"Telangana\",\"bankAddressLine1\":\"Bankaddress5\",\"bankAddressLine2\":\"bankaddressline25\",\"bankCity\":\"Hyderabad\",\"bankState\":\"Telangana\",\"payeeType\":\"Individual\",\"routingNumber\":\"98571\"}]}"
}
Response:

Parameters

bankAddressLine1 (Mandatory)

Specifies the first line of bank address.

bankAddressLine2 (Mandatory)

Specifies the second line of bank address.
payeeNickName (Mandatory)

Specifies the nick name of the account.

zipCode (Mandatory)

Specifies the Zip code of the bank.

country (Mandatory)

Specifies the name of the country.

fromAccountNumber (Mandatory)

Specifies the account number of the payee.
payeeType (Mandatory)

Specifies the type of payee.

payeeName (Mandatory)

Specifies the name of the payee.

payeeCurrency (Mandatory)

Specifies the currency of the payee.

bankName (Mandatory)

Specifies the name of the bank.
cityName (Mandatory)

Specifies the name of the city.

wireFileExecution_id (Mandatory)

Specifies the unique wire file execution.

wireTemplateExecution_id (Mandatory)

Specifies the unique wire template execution ID.

state (Mandatory)

Specifies the state of the payee.
payeeAccountNumber (Mandatory)

Specifies the account number of the payee.

amount (Mandatory)

Specifies the amount.
onetime_id (Mandatory)

Specifies the unique ID.

bankState (Mandatory)

Specifies state in which bank is located.

payeeAddressLine1 (Mandatory)

Specifies the first line of payee address.

payeeAddressLine2 (Mandatory)

Specifies the second line of payee address.

wireAccountType (Mandatory)

Specifies type of wire account.

transactionId (Mandatory)

Specifies the unique transaction ID.

bankCity (Mandatory)

Specifies the city name of the bank.

transactionType (Mandatory)

Specifies the type of transaction.
routingNumber (Mandatory)

Specifies the routing number of the payee.

confirmationNumber (Mandatory)

Specifies the confirmation number.

status (Mandatory)

Specifies the status of the transaction.

{
    "BulkWireExecutionDetails": [{
        "totalCount": "3",
        "successCount": "3",
        "failedCount": "0",
        "pendingCount": "0",
        "Domestic": [{
            "bankAddressLine1": "Bankaddress1",
            "bankAddressLine2": "bankaddressline21",
            "payeeNickName": "accountNickname1",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118656",
            "payeeType": "Individual",
            "payeeName": "dgf",
            "payeeCurrency": "£",
            "bankName": "recipientBank1",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "0",
            "wireTemplateExecution_id": "28",
            "state": "Telangana",
            "payeeAccountNumber": "1234536",
            "amount": "1",
            "onetime_id": "195",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine11",
            "payeeAddressLine2": "recipientAddressline21",
            "wireAccountType": "Domestic",
            "transactionId": "232",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "routingNumber": "98567",
            "confirmationNumber": "20886",
            "status": "Executed"
        }, {
            "bankAddressLine1": "Bankaddress3",
            "bankAddressLine2": "bankaddressline23",
            "payeeNickName": "accountNickname3",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118656",
            "payeeType": "Individual",
            "payeeName": "ewr",
            "payeeCurrency": "£",
            "bankName": "recipientBank3",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "0",
            "wireTemplateExecution_id": "28",
            "state": "Telangana",
            "payeeAccountNumber": "1234538",
            "amount": "1",
            "onetime_id": "196",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine13",
            "payeeAddressLine2": "recipientAddressline23",
            "wireAccountType": "Domestic",
            "transactionId": "233",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "routingNumber": "98569",
            "confirmationNumber": "20887",
            "status": "Executed"
        }, {
            "bankAddressLine1": "Bankaddress5",
            "bankAddressLine2": "bankaddressline25",
            "payeeNickName": "accountNickname5",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118656",
            "payeeType": "Individual",
            "payeeName": "ewr",
            "payeeCurrency": "£",
            "bankName": "recipientBank5",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "0",
            "wireTemplateExecution_id": "28",
            "state": "Telangana",
            "payeeAccountNumber": "1234540",
            "amount": "1",
            "onetime_id": "197",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine15",
            "payeeAddressLine2": "recipientAddressline25",
            "wireAccountType": "Domestic",
            "transactionId": "234",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "routingNumber": "98571",
            "confirmationNumber": "20888",
            "status": "Executed"
        }],
        "International": []
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpTransactionServices/CreateBulkWireTransfer

Field Mapping

UI field Experience API field MS  API field Transact API field

bankAddressLine1

bankAddressLine1

NA

NA

bankAddressLine2

bankAddressLine2

NA

NA

payeeNickName

payeeNickName

NA

NA

zipCode

zipCode

NA

NA

country

country

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeType

payeeType

NA

NA

payeeName

payeeName

NA

NA

payeeCurrency

payeeCurrency

NA

NA

bankName

bankName

NA

NA

cityName

cityName

NA

NA

wireFileExecution_id

wireFileExecution_id

NA

NA

wireFileExecution_id

wireFileExecution_id

NA

NA

state

state

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

amount

amount

NA

NA

wireAccountType

wireAccountType

NA

NA

transactionId

transactionId

NA

NA

transactionType

transactionType

NA

NA

confirmationNumber

confirmationNumber

NA

NA
 
Description: This API allows the user to fetch the details of all the wire transactions that were executed during a Bulk Wire Transfer. The user must provide the ExecutionId as an input request to fetch all the corresponding wire transfer details.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWireTransaction/getTransactionsByBulkWireTemplateExecutionId
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

BulkWireTemplateExecution_id(Mandatory)

Specifies the unique Bulk Wire Template ID that gets generated post the creation of a Bulk Wire Template. Based on this ID the transactions performed through the Bulk Wire template are to be fetched.

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

searchFilter

Specifies the filter element based on which the transactions must be fetched.

{
    "BulkWireTemplateExecution_id": "5",
    "sortByParam": "",
    "sortOrder": "",
    "searchString": "",
    "statusFilter": ""
}
Response:

View the Response Parameters

Parameters

totalCount(Mandatory)

Specifies the total count.

successCount(Mandatory)

Specifies the count of successful transaction.

bankAddressLine1(Mandatory)

Specifies the first line of bank address.

bankAddressLine2

Specifies the second line of bank address.

payeeNickName(Mandatory)

Specifies the nick name of the payee.

zipCode(Mandatory)

Specifies zip code.

country(Mandatory)

Specifies the name of the country .

fromAccountNumber(Mandatory)

Specifies the account number.

payeeType(Mandatory)

Specifies the type of the payee.

payeeName(Mandatory)

Specifies the name of the payee.

payeeCurrency(Mandatory)

Specifies the currency of the payee.

bankName(Mandatory)

Specifies the name of the bank.

cityName(Mandatory)

Specifies the name of the city.

wireTemplateExecution_id(Mandatory)

Specifies the unique Id of the wire template execution.

state(Mandatory)

Specifies the state of the payee.

payeeAccountNumber(Mandatory)

Specifies the account number of the payee.

amount(Mandatory)

Specifies the amount.

onetime_id

Specifies the unique one time ID.

bankState(Mandatory)

Specifies the bank name of the state.

payeeAddressLine1(Mandatory)

Specifies the first line of the payee address.

payeeAddressLine2

Specifies the second line of the payee address.

wireAccountType(Mandatory)

Specifies the type of the wire account.

transactionId(Mandatory)

Specifies the unique transaction ID.

bankCity(Mandatory)

Specifies the city name in which bank resides.

transactionType(Mandatory)

Specifies the type of the transaction.

routingNumber(Mandatory)

Specifies the routing number.

confirmationNumber(Mandatory)

Specifies the confirmation number.

status(Mandatory)

Specifies whether the status is success or failure.

{
    "BulkWireTemplateExecutionDetails": [{
        "totalCount": "4",
        "successCount": "4",
        "failedCount": "0",
        "pendingCount": "0",
        "Domestic": [{
            "bankAddressLine1": "westRoad",
            "bankAddressLine2": "",
            "payeeNickName": "golf",
            "zipCode": "123456",
            "country": "United States of America",
            "fromAccountNumber": "131652",
            "payeeType": "Individual",
            "payeeName": "userman",
            "payeeCurrency": "₹",
            "bankName": "bankOfBaroda",
            "cityName": "dubai",
            "wireTemplateExecution_id": "5",
            "state": "Encamp",
            "payeeAccountNumber": "989898",
            "amount": "1",
            "onetime_id": "120",
            "bankState": "Encamp",
            "payeeAddressLine1": "streetroad",
            "payeeAddressLine2": "",
            "wireAccountType": "Domestic",
            "transactionId": "131",
            "bankCity": "encamp",
            "transactionType": "Wire",
            "routingNumber": "1234789",
            "confirmationNumber": "20476",
            "status": "Executed"
        }, {
            "bankAddressLine1": "sothStreet",
            "bankAddressLine2": "",
            "payeeNickName": "Scooby",
            "zipCode": "213454",
            "country": "United States of America",
            "fromAccountNumber": "131652",
            "payeeType": "Individual",
            "payeeName": "user",
            "payeeCurrency": "₹",
            "bankName": "bank",
            "cityName": "dubai",
            "wireTemplateExecution_id": "5",
            "state": "Encamp",
            "payeeAccountNumber": "123423",
            "amount": "1",
            "onetime_id": "121",
            "bankState": "La Massana",
            "payeeAddressLine1": "westCarStreet",
            "payeeAddressLine2": "",
            "wireAccountType": "Domestic",
            "transactionId": "132",
            "bankCity": "chennai",
            "transactionType": "Wire",
            "routingNumber": "12345213",
            "confirmationNumber": "20478",
            "status": "Executed"
        }, {
            "bankAddressLine1": "address",
            "bankAddressLine2": "",
            "payeeNickName": "tom",
            "zipCode": "123435",
            "country": "United States of America",
            "fromAccountNumber": "131652",
            "payeeType": "Individual",
            "payeeName": "tom",
            "payeeCurrency": "₹",
            "bankName": "bank",
            "cityName": "chennai",
            "wireTemplateExecution_id": "5",
            "state": "La Massana",
            "payeeAccountNumber": "545454",
            "amount": "1",
            "onetime_id": "123",
            "bankState": "Ordino",
            "payeeAddressLine1": "street",
            "payeeAddressLine2": "",
            "wireAccountType": "Domestic",
            "transactionId": "133",
            "bankCity": "city",
            "transactionType": "Wire",
            "routingNumber": "8987897",
            "confirmationNumber": "20477",
            "status": "Executed"
        }, {
            "bankAddressLine1": "bangalore",
            "bankAddressLine2": "",
            "payeeNickName": "batman",
            "zipCode": "123451",
            "country": "United States of America",
            "fromAccountNumber": "131652",
            "payeeType": "Individual",
            "payeeName": "testUser",
            "payeeCurrency": "₹",
            "bankName": "HDfFC",
            "cityName": "Kolakta",
            "wireTemplateExecution_id": "5",
            "state": "Ordino",
            "payeeAccountNumber": "116785",
            "amount": "1",
            "onetime_id": "122",
            "bankState": "Ordino",
            "payeeAddressLine1": "Kolkata",
            "payeeAddressLine2": "",
            "wireAccountType": "Domestic",
            "transactionId": "134",
            "bankCity": "bangalore",
            "transactionType": "Wire",
            "routingNumber": "7654432",
            "confirmationNumber": "20479",
            "status": "Executed"
        }],
        "International": []
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error."
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getTransactionsByBulkWireTemplateExecutionId

Field Mapping

UI field Experience API field MS  API field Transact API field

bankAddressLine1

bankAddressLine1

NA

NA

bankAddressLine2

bankAddressLine2

NA

NA

payeeNickName

payeeNickName

NA

NA

zipCode

zipCode

NA

NA

country

country

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeType

payeeType

NA

NA

payeeName

payeeName

NA

NA

payeeCurrency

payeeCurrency

NA

NA

bankName

bankName

NA

NA

cityName

cityName

NA

NA

wireTemplateExecution_id

wireTemplateExecution_id

NA

NA

state

state

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

amount

amount

NA

NA

onetime_id

onetime_id

NA

NA

bankState

bankState

NA

NA

payeeAddressLine1

payeeAddressLine1

NA

NA

payeeAddressLine2

payeeAddressLine2

NA

NA

wireAccountType

wireAccountType

NA

NA

transactionId

transactionId

NA

NA

bankCity

bankCity

NA

NA

transactionType

transactionType

NA

NA

routingNumber

routingNumber

NA

NA

confirmationNumber

confirmationNumber

NA

NA

status

status

NA

NA
 
Description: This API allows the user to fetch the details of all the Bulk Wire transfers that were executed by using a Bulk Wire template. The user must provide the TemplateId as an input request to fetch all the corresponding bulk wire transfer details.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWireTransaction/getBulkWireTemplateTransactionDetail
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateID(Mandatory)

Specifies the unique bulk wire template ID.

{
    "bulkWireTemplateID": "ZRzRSG2X-MlHcJYMO-qWjdZKgM-yk4eCX5x",
    "pageOffset": 0,
    "pageSize": 10
}
Response:

Parameters

bulkWireTransactionID(Mandatory)

Specifies the unique ID of the Bulk Wire Transaction.

bulkWireTemplateID(Mandatory)

Specifies the unique ID for bulk wire template.

totalCountOfTransactions(Mandatory)

Specifies the total count of transactions.

totalCountOfDomesticTransactions(Mandatory)

Specifies the number of domestic transactions performed by the customer.

totalCountOfInternationalTransactions(Mandatory)

Specifies the number of international transactions performed by the customer.

createdts(Mandatory)

Specifies the created time stamp and date of the bulk wire template.

lastmodifiedts(Mandatory)

Specifies the last modified time stamp and date the bulk wire template.

initiatedBy(Mandatory)

Specifies the unique ID of the name.

firstname(Mandatory)

Specifies the first name.

lastname(Mandatory)

Specifies the last name.

{
    "BulkWireTemplateTransactDetails": [{
        "bulkWireTransactionID": "2",
        "bulkWireTemplateID": "ZRzRSG2X-MlHcJYMO-qWjdZKgM-yk4eCX5x",
        "totalCountOfTransactions": "3",
        "totalCountOfDomesticTransactions": "3",
        "totalCountOfInternationalTransactions": "0",
        "createdts": "2021-09-01T10:57:24Z",
        "lastmodifiedts": "2021-09-01T10:57:24Z",
        "initiatedBy": "2102609132",
        "transactionDate": "2021-09-01T10:57:24Z",
        "firstname": "Temenos",
        "lastname": "Temenos"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getBulkWireTemplateTransactionDetail

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireTransactionID

bulkWireTransactionID

NA

NA

bulkWireTemplateID

bulkWireTemplateID

NA

NA

totalCountOfTransactions

totalCountOfTransactions

NA

NA

totalCountOfDomesticTransactions

totalCountOfDomesticTransactions

NA

NA

totalCountOfInternationalTransactions

totalCountOfInternationalTransactions

NA

NA

createdts

createdts

NA

NA

lastmodifiedts

lastmodifiedts

NA

NA

initiatedBy

initiatedBy

NA

NA

transactionDate

transactionDate

NA

NA

firstname

firstname

NA

NA

lastname

lastname

NA

NA
 
Description: This API allows the user to extract and return the recipient and recipient details from a Bulk Wire Template/Bulk Wire file.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWireFile/uploadBWFile
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

View the Response Parameters

Parameters

bulkWireFileName(Mandatory)

Specifies an array

bulkWireFileContents(Mandatory)

Specifies an array 

{
    "bulkWireFileName": "SampleBulkWireFile.xls",
    "bulkWireFileContents": "0M8R4KGxGuEAAAAAAAAAAAAAAAAAAAAAPgADAP7/CQAGAAAAAAAAAAAAAAABAAAAOgAAAAAAAAAAEAAA/v///wAAAAD+////AAAAADkAAAD////////////////////////////////////////////////////////////////////////////ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEIAAgCwBGEBAgAAAMABAAA9AQIAAQCcAAIAEQAZAAIAAAASAAIAAAATAAIAAACvAQIAAAC8AQIAAAA9ABIA/3//fwBaECM4AAAAAAABAFgCQAACAAAAjfKCogIywjIzBfKTtfKCogXCgjLCMjMFwpO18oKiAiLSJfKTtfKEBfKR4EPwAsADoAAF8oIiQiKiAjLCMjMC4wMF8pO18oIiQiKiBcKCMsIyMwLjAwXCk7XygiJCIqICItIj8/Xyk7XyhAXykeBDYAKwAxAABfKCogIywjIzAuMDBfKTtfKCogXCgjLCMjMC4wMFwpO18oKiAiLSI/P18pO18oQF8pHgQVAKQAEAAAIlllcyI7IlllcyI7Ik5vIh4EGgClABUAACJUcnVlIjsiVHJ1ZSI7IkZhbHNlIh4EFACmAA8AACJPbiI7Ik9uIjsiT2ZmIh4EXQCnACwAAVsAJACsIC0AMgBdAFwAIAAjACwAIwAjADAALgAwADAAXwApADsAWwBSAGUAZABdAFwAKABbACQArCAtADIAXQBcACAAIwAsACMAIwAwAC4AMAAwAFwAKQAeBCMAqAAeAABbJC00MDldZGRkZFwsXCBtbW1tXCBkXCxcIHl5eXkeBBoAqQAVAABbJC00MDldaDptbTpzc1wgQU0vUE3gABQAAAAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAAAAAAAAAAAAAAAwCDgABQABQAAAPX/IAA
Response:

View the Response Parameters

Parameters

noOfTransactions(Mandatory)

Specifies the first line of the recipient's address.

bulkWireFileName(Mandatory)

Specifies the second line of the recipient's address.

bulkWireFileID(Mandatory)

Specifies the zip code of the recipient.

{
    "noOfTransactions": "4",
    "opstatus": 0,
    "bulkWireFileName": "SampleBulkWireFile_2021-09-24T09:00:56.xls",
    "bulkWireFileID": "tO0q6JNz-oiLa3ttI-IUnsyhAV-GKA0Ocu5",
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/UploadBWFile

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireFileContents

bulkWireFileContents

NA

NA

noOfTransactions

noOfTransactions

NA

NA

bulkWireFileName

bulkWireFileName

NA

NA

bulkWireFileID

bulkWireFileID

NA

NA
 
Description: This API allows the user to download the sample file for Bulk Wire Template / Bulk Wire File based on the input request provided by the user.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWireFile/initiateDownloadBulkWireSampleFile
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request: 
{}
Response: 
{
    "opstatus": 0,
    "fileId": "UkmAwzk0-AqU5E3mk-Ot6xP4xo-Sskuf9CV",
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/initiateDownloadBulkWireSampleFile

Field Mapping

UI field Experience API field MS  API field Transact API field

fileId

fileId

NA

NA
 
Description: This API allows the user to retrieve bulk wire template line items.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWire/getBulkWireTemplateLineItems
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireTemplateID(Mandatory)

Specifies the unique bulkWireTemplateID.

{
    "bulkWireTemplateID": "ZRzRSG2X-MlHcJYMO-qWjdZKgM-yk4eCX5x",
    "sortByParam": "",
    "sortOrder": "",
    "searchString": "",
    "groupBy": ""
}
Response:

Parameters

bulkWireTemplateLineItemID(Mandatory)

Specifies the unique bulkWireTemplateLineItemID.

bulkWireTransferType(Mandatory)

Specifies the type of wire transfer.

transactionType(Mandatory)

Specifies the type of transaction.

routingNumber(Mandatory)

Specifies the routing number.

accountNickname(Mandatory)

Specifies the nick name of the account.

recipientAccountNumber(Mandatory)

Specifies the recipient account number.

recipientName(Mandatory)

Specifies the recipient name.

recipientAddressLine1(Mandatory)

Specifies the recipient first line of address.

recipientAddressLine2(Mandatory)

Specifies the recipient second line of address.

recipientCity(Mandatory)

Specifies the recipient name of the city.

recipientState(Mandatory)

Specifies the recipient name of the state.

recipientZipCode(Mandatory)

Specifies the recipient postal code.

recipientCountryName(Mandatory)

Specifies the recipient name of the country.

recipientBankName(Mandatory)

Specifies the recipient name of the bank.

recipientBankAddress1(Mandatory)

Specifies the bank first line of address.

recipientBankAddress2(Mandatory)

Specifies the second line of address.

recipientBankcity(Mandatory)

Specifies the bank city name.

recipientBankstate(Mandatory)

Specifies the bank state name.

recipientBankZipCode(Mandatory)

Specifies the bank postal code.

payeeId(Mandatory)

Specifies the unique payeeId.

templateRecipientCategory(Mandatory)

Specifies the category of the template.

{
    "BulkWireTemplateLineItems": [{
        "bulkWireTemplateLineItemID": "4",
        "bulkWireTransferType": "Domestic",
        "transactionType": "Individual",
        "routingNumber": "7654432",
        "accountNickname": "batman",
        "recipientAccountNumber": "116785",
        "recipientName": "testUser",
        "recipientAddressLine1": "Kolkata",
        "recipientAddressLine2": "",
        "recipientCity": "Kolakta",
        "recipientState": "Ordino",
        "recipientZipCode": "123451",
        "recipientCountryName": "United States of America",
        "recipientBankName": "HDfFC",
        "recipientBankAddress1": "bangalore",
        "recipientBankAddress2": "",
        "recipientBankcity": "bangalore",
        "recipientBankstate": "Ordino",
        "recipientBankZipCode": "124532",
        "payeeId": "08947396",
        "templateRecipientCategory": "EXISTINGRECIPIENT"
    }, {
        "bulkWireTemplateLineItemID": "3",
        "bulkWireTransferType": "Domestic",
        "transactionType": "Individual",
        "routingNumber": "12345213",
        "accountNickname": "Scooby",
        "recipientAccountNumber": "123423",
        "recipientName": "user",
        "recipientAddressLine1": "westCarStreet",
        "recipientAddressLine2": "",
        "recipientCity": "dubai",
        "recipientState": "Encamp",
        "recipientZipCode": "213454",
        "recipientCountryName": "United States of America",
        "recipientBankName": "bank",
        "recipientBankAddress1": "sothStreet",
        "recipientBankAddress2": "",
        "recipientBankcity": "chennai",
        "recipientBankstate": "La Massana",
        "recipientBankZipCode": "123456",
        "payeeId": "53509722",
        "templateRecipientCategory": "EXISTINGRECIPIENT"
    }, {
        "bulkWireTemplateLineItemID": "5",
        "bulkWireTransferType": "Domestic",
        "transactionType": "Individual",
        "routingNumber": "1234789",
        "accountNickname": "golf",
        "recipientAccountNumber": "989898",
        "recipientName": "userman",
        "recipientAddressLine1": "streetroad",
        "recipientAddressLine2": "",
        "recipientCity": "dubai",
        "recipientState": "Encamp",
        "recipientZipCode": "123456",
        "recipientCountryName": "United States of America",
        "recipientBankName": "bankOfBaroda",
        "recipientBankAddress1": "westRoad",
        "recipientBankAddress2": "",
        "recipientBankcity": "encamp",
        "recipientBankstate": "Encamp",
        "recipientBankZipCode": "123454",
        "payeeId": "34456377",
        "templateRecipientCategory": "EXISTINGRECIPIENT"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getBulkWireTemplateLineItems

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireTemplateLineItemID

bulkWireTemplateLineItemID

NA

NA

bulkWireTransferType

bulkWireTransferType

NA

NA

transactionType

transactionType

NA

NA

routingNumber

routingNumber

NA

NA

accountNickname

accountNickname

NA

NA

recipientAccountNumber

recipientAccountNumber

NA

NA

recipientName

recipientName

NA

NA

recipientAddressLine1

recipientAddressLine1

NA

NA

recipientCity

recipientCity

NA

NA

recipientState

recipientState

NA

NA

recipientZipCode

recipientZipCode

NA

NA

recipientCountryName

recipientCountryName

NA

NA

recipientCountryName

recipientCountryName

NA

NA

payeeId

payeeId

NA

NA

templateRecipientCategory

templateRecipientCategory

NA

NA

recipientBankstate

recipientBankstate

NA

NA
 
Description: This API allows the user to fetch the transaction details from a bulk wire file.
Method: POST
URL: {base_url}services/data/v1/BulkWireObjects/operations/BulkWireTransaction/getBulkWireFileTransactionDetail
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

bulkWireFileID (Mandatory)

Specifies the unique ID of the bulk wire file of which, the transaction details must be fetched.

pageOffset

Specifies the row from where the data must be retreived. The offset value is often used together with the limit.

pageSize

Specifies the number of rows that must be returned in the result.

{
  "bulkWireFileID":"xXTpNFjI-ERZ7V7bp-RlQM8d7i-ezzD8Eyu",
  "pageOffset":0,
  "pageSize":10
}
Response:

Parameters

bulkWireTransactionID

Specifies the unique bulkWireTransactionID.

bulkWireTemplateID

Specifies the unique ID of the bulkWireTemplateID.

totalCountOfDomesticTransactions

Specifies the number of total domestic transactions performed through the Bulk Wire file.

totalCountOfInternationalTransactions

Specifies the total number of international transactions performed through the Bulk Wire file..

totalCountOfTransactions

Specifies the total number of transactions performed through the Bulk Wire file.

transactionDate

Specifies the date on which the transaction occurred.

createdts

Specifies the created time stamp.

lastmodifiedts

Specifies the time stamp on which the transaction details were last modified.

initiatedBy

Specifies the unique ID of the user who initiated the transaction.

firstname

Specifies the first name of the user who performed the transaction.

lastname

Specifies the last name of the user who performed the transaction.

{
    "BulkWireTemplateTransactDetails": [{
        "bulkWireTransactionID": "2",
        "bulkWireTemplateID": "ZRzRSG2X-MlHcJYMO-qWjdZKgM-yk4eCX5x",
        "totalCountOfTransactions": "3",
        "totalCountOfDomesticTransactions": "3",
        "totalCountOfInternationalTransactions": "0",
        "createdts": "2021-09-01T10:57:24Z",
        "lastmodifiedts": "2021-09-01T10:57:24Z",
        "initiatedBy": "2102609132",
        "transactionDate": "2021-09-01T10:57:24Z",
        "firstname": "Temenos",
        "lastname": "Temenos"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getBulkWireFileTransactionDetails

Field Mapping

UI field Experience API field MS  API field Transact API field

bulkWireTransactionID

bulkWireTransactionID

NA

NA

bulkWireFileID

bulkWireFileID

NA

NA

totalCountOfTransaction

totalCountOfTransaction

NA

NA

totalCountOfDomesticTransactiions

totalCountOfDomesticTransactiions

NA

NA

totalCountOfInternationalTransactions

totalCountOfInternationalTransactions

NA

NA

createdts

createdts

NA

NA

lastmodifiedts

lastmodifiedts

NA

NA

initiatedBy

initiatedBy

NA

NA

transactionDate

transactionDate

NA

NA

firstname

firstname

NA

NA

lastname

lastname

NA

NA
 
Description: This API allows the user to fetch the execution details of the bulk wire transaction.
Method: POST
URL: {base_url}/services/data/v1/BulkWireObjects/operations/BulkWireTransaction/getTransactionsByBulkWireFileExecutionId
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

BulkWireFileExecution_id(Mandatory)

Specifies the unique ID for the bulk wire execution ID.

sortByParam

Specifies the field in the response based on which the list of records must be sorted. By default, the list of records would be sorted based on the date on which the request was sent (sentDate).

sortOrder

Specifies the order in which the list of fetched records must be sorted, such as in ascending or descending (ASC/DESC) order. By default, the value is set to DESC for the date on which the request was sent (sentDate).

searchString

Specifies the free text that can be entered to search for a set of records that matches the text that is entered.

statusFilter

Specifies the filter for status.

{
  "BulkWireFileExecution_id":"1",
  "sortByParam":"",
  "sortOrder":"",
  "searchString":"",
  "statusFilter":""
}
Response:

Parameters

BulkWireFileExecutionDetails

Specifies an array of Bulk Wire Execution details.

bankAddressLine1(Mandatory)

Specifies the first line of bank's address.

bankAddressLine2(Mandatory)

Specifies the second line of bank's address.

payeeNickName(Mandatory)

Specifies the nickname of the payee.

zipCode(Mandatory)

Specifies the zipcode.

country(Mandatory)

Specifies the name of the country.

fromAccountNumber(Mandatory)

Specifies the account number from which the amount is debited.

notes(Mandatory)

Specifies the additional notes.

payeeType(Mandatory)

Specifies the type of payee.

swiftCode(Mandatory)

Specifies the swift code for international.

payeeName(Mandatory)

Specifies the name of the payee.

payeeCurrency(Mandatory)

Specifies the currency in which the payee is located.

bankName(Mandatory)

Specifies the name of the bank.

cityName(Mandatory)

Specifies the name of the city.

wireFileExecution_id(Mandatory)

Specifies the unique ID of the wire file execution.

state(Mandatory)

Specifies the name of the state.

payeeAccountNumber(Mandatory)

Specifies the account number of the payee.

amount(Mandatory)

Specifies the domestic amount.

onetime_id(Mandatory)

Specifies the unique ID of the one time transfer.

bankState(Mandatory)

Specifies the name of the state in which the bank is located.

payeeAddressLine1(Mandatory)

Specifies the first line of address of the bank.

payeeAddressLine2(Mandatory)

Specifies the second line of address of the bank.

wireAccountType(Mandatory)

Specifies the type of wire account.

transactionId(Mandatory)

Specifies the unique ID of the transaction.

bankCity(Mandatory)

Specifies the name of the city in which the bank is located.

transactionType(Mandatory)

Specifies the type of transaction.

internationalRoutingCode(Mandatory)

Specifies the international routing code.

status(Mandatory)

Specifies the status of the transaction.

{
    "BulkWireFileExecutionDetails": [{
        "totalCount": "4",
        "successCount": "4",
        "failedCount": "0",
        "pendingCount": "0",
        "Domestic": [{
            "bankAddressLine1": "Bankaddress2",
            "bankAddressLine2": "bankaddressline22",
            "payeeNickName": "wer",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118567",
            "notes": "2nd records",
            "payeeType": "Business",
            "swiftCode": "abc124",
            "payeeName": "wer",
            "payeeCurrency": "GBP",
            "bankName": "recipientBank2",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "2",
            "state": "Telangana",
            "payeeAccountNumber": "1234537",
            "amount": "2.34",
            "onetime_id": "155",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine12",
            "payeeAddressLine2": "recipientAddressline22",
            "wireAccountType": "Domestic",
            "transactionId": "179",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "confirmationNumber": "20741",
            "internationalRoutingCode": "456183",
            "status": "Executed"
        }],
        "International": [{
            "bankAddressLine1": "Bankaddress3",
            "bankAddressLine2": "bankaddressline23",
            "payeeNickName": "ewr",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118567",
            "notes": "3rd records",
            "payeeType": "Individual",
            "swiftCode": "abc125",
            "payeeName": "ewr",
            "payeeCurrency": "INR",
            "bankName": "recipientBank3",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "2",
            "state": "Telangana",
            "payeeAccountNumber": "1234538",
            "amount": "1.22",
            "onetime_id": "152",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine13",
            "payeeAddressLine2": "recipientAddressline23",
            "wireAccountType": "International",
            "transactionId": "176",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "confirmationNumber": "20739",
            "internationalRoutingCode": "456184",
            "status": "Executed"
        }, {
            "bankAddressLine1": "Bankaddress1",
            "bankAddressLine2": "bankaddressline21",
            "payeeNickName": "dgf",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118567",
            "notes": "1st records",
            "payeeType": "Individual",
            "swiftCode": "abc123",
            "payeeName": "dgf",
            "payeeCurrency": "USD",
            "bankName": "recipientBank1",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "2",
            "state": "Telangana",
            "payeeAccountNumber": "1234536",
            "amount": "1.22",
            "onetime_id": "153",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine11",
            "payeeAddressLine2": "recipientAddressline21",
            "wireAccountType": "International",
            "transactionId": "177",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "confirmationNumber": "20738",
            "internationalRoutingCode": "456182",
            "status": "Executed"
        }, {
            "bankAddressLine1": "Bankaddress5",
            "bankAddressLine2": "bankaddressline25",
            "payeeNickName": "ewr",
            "zipCode": "500081",
            "country": "India",
            "fromAccountNumber": "118567",
            "notes": "5th records",
            "payeeType": "Individual",
            "swiftCode": "abc127",
            "payeeName": "ewr",
            "payeeCurrency": "EUR",
            "bankName": "recipientBank5",
            "cityName": "Hyderabad",
            "wireFileExecution_id": "2",
            "state": "Telangana",
            "payeeAccountNumber": "1234540",
            "amount": "1.22",
            "onetime_id": "154",
            "bankState": "Telangana",
            "payeeAddressLine1": "recipientAddressLine15",
            "payeeAddressLine2": "recipientAddressline25",
            "wireAccountType": "International",
            "transactionId": "178",
            "bankCity": "Hyderabad",
            "transactionType": "Wire",
            "confirmationNumber": "20740",
            "internationalRoutingCode": "456186",
            "status": "Executed"
        }]
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):
  • Error Code: 12403
    Error Message: "SECURITY EXCEPTION - UNAUTHORIZED ACCESS."
  • Error Code: 39002
    Error Message: "Unable to process request, SCA verification failed."
  • Error Code: 12000
    Error Message: "Internal service error"
Enterprise Provider: DBX DB
Enterprise API:

{base_url}/services/dbpBulkWireServices/getTransactionsByBulkWireFileExecutionId

Field Mapping

UI field Experience API field MS  API field Transact API field

bankAddressLine1

bankAddressLine1

NA

NA

bankAddressLine2

bankAddressLine2

NA

NA

payeeNickName

payeeNickName

NA

NA

zipCode

zipCode

NA

NA

country

country

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

notes

notes

NA

NA

payeeType

payeeType

NA

NA

swiftCode

swiftCode

NA

NA

payeeName

payeeName

NA

NA

payeeCurrency

payeeCurrency

NA

NA

bankName

bankName

NA

NA

cityName

cityName

NA

NA

wireFileExecution_id

wireFileExecution_id

NA

NA

state

state

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

amount

amount

NA

NA

onetime_id

onetime_id

NA

NA

bankState

bankState

NA

NA

payeeAddressLine1

payeeAddressLine1

NA

NA

payeeAddressLine2

payeeAddressLine2

NA

NA

wireAccountType

wireAccountType

NA

NA

transactionId

transactionId

NA

NA

bankCity

bankCity

NA

NA

transactionType

transactionType

NA

NA

confirmationNumber

confirmationNumber

NA

NA

internationalRoutingCode

internationalRoutingCode

NA

NA
 
Parameter Name DataType 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
 
Parameter Name DataType Optional/Mandatory Description

bulkWireCategoryFilter

 string

 Mandatory

Bulk Wire Category Filter

bulkWireID

string

Mandatory

Bulk wire ID

bulkWireName

string

Mandatory

Bulk Wire name

noOfTransactions

string

Mandatory

Number of transactions

noOfDomesticTransactions

string

Mandatory

Number of domestic transactions

noOfInternationalTransactions

string

Mandatory

Number of International Transactions

createdts

string

Mandatory

Created

lastmodifiedts

string

Mandatory

Last modified

lastExecutedOn

string

Mandatory

Last Executed on

firstname

string

Mandatory

First name

lastname

string

Mandatory

Last name

defaultFromAccount

string

Mandatory

default from account

defaultCurrency

string

Mandatory

default currency

bulkWireCategory

string

Mandatory

Bulk wire category

bulkWireTemplateID

string

Mandatory

Bulk wire template id

searchString

string

Mandatory

search string

sortByParam

string

Mandatory

sort by param

sortOrder

string

Mandatory

sort order

groupBy

string

Mandatory

group by

bulkWireTemplateLineItemID

string

Mandatory

bulk wire template line item id

bulkWireTransferType

string

Mandatory

bulk wire transfer type

transactionType

string

Mandatory

transaction type

routingNumber

string

Mandatory

routing number

accountNickname

string

Mandatory

account nick name

recipientAccountNumber

string

Mandatory

recipient account number

recipientName

string

Mandatory

recipient name

recipientAddressLine1

string

Mandatory

recipient address

recipientAddressLine2

string

Mandatory

recipient address

recipientCity

string

Mandatory

recipient city

recipientState

string

Mandatory

recipient state

recipientZipCode

string

Mandatory

recipient zip code number

recipientCountryName

string

Mandatory

recipient country name

recipientBankName

string

Mandatory

recipient bank name

recipientBankAddress1

string

Mandatory

recipient bank address

recipientBankAddress2

string

Mandatory

recipient bank address

recipientBankcity

string

Mandatory

recipient bank city

recipientBankstate

string

Mandatory

recipient bank state

recipientBankZipCode

string

Mandatory

recipient bank zip code

payeeId

string

Mandatory

payee id

templateRecipientCategory

string

Mandatory

template recipient category

bulkWireTemplateName

string

Mandatory

Bulk wire template name
 
Parameter Name DataType Optional/Mandatory Description

 fileId

 string

 Mandatory

File ID

bulkWireFileName

 string

 Mandatory

Bulk wire file name

bulkWireFileContents

 string

 Mandatory

Bulk wire file contents

bulkWireFileID

 string

 Mandatory

Bulk wire file id

noOfTransactions

 string

 Mandatory

Number of transactions

recipientBankAddress1

 string

 Mandatory

Recipient Bank Address

recipientBankAddress2

 string

 Mandatory

Recipient Bank address

recipientZipCode

 string

 Mandatory

recipient zip code

fromAccountNumber

 string

 Mandatory

from account number

note

 string

 Mandatory

note

swiftCode

 string

 Mandatory

swift code

recipientName

 string

 Mandatory

recipient name

recipientBankName

 string

 Mandatory

recipient bank name

recipientCity

 string

 Mandatory

recipient city

bulkWireFileLineItemID

 string

 Mandatory

bulk wire file line item id

recipientState

 string

 Mandatory

recipient state

bulkWireTransferType

 string

 Mandatory

bulk wire transfer type

transactionType

 string

 Mandatory

transaction type

amount

 string

 Mandatory

amount

currency

 string

 Mandatory

currency

recipientBankstate

 string

 Mandatory

recipient bank state

recipientAddressLine1

 string

 Mandatory

recipient address

recipientAddressLine2

 string

 Mandatory

recipient address

recipientBankZipCode

 string

 Mandatory

recipient bank zip code

recipientBankcity

 string

 Mandatory

recipient bank city

recipientAccountNumber

 string

 Mandatory

recipient account number

routingNumber

 string

 Mandatory

routing number

recipientCountryName

 string

 Mandatory

recipient country name

internationalRoutingNumber

 string

 Mandatory

international routing number
 
Parameter Name DataType Optional/Mandatory Description

bulkWireTemplateID

 string

 Mandatory

Bulk wire template id

bulkWireTransactionID

 string

 Mandatory

Bulk wire transaction id

bulkWireTemplateID

 string

 Mandatory

bulk wire template id

totalCountOfTransactions

 string

 Mandatory

total count of transactions

totalCountOfDomesticTransactions

 string

 Mandatory

Total count of domestic transactions

totalCountOfInternationalTransactions

 string

 Mandatory

Total count of international transactions

createdts

 string

 Mandatory

created

lastmodifiedts

 string

 Mandatory

Last modified

initiatedBy

 string

 Mandatory

initiated by

firstname

 string

 Mandatory

First name

lastname

 string

 Mandatory

Last name

BulkWireTemplateExecution_id

 string

 Mandatory

Bulk wire template execution id

sortByParam

 string

 Mandatory

sort by param

sortOrder

 string

 Mandatory

sort order

searchString

 string

 Mandatory

search string

statusFilter

 string

 Mandatory

status filter

bankAddressLine1

 string

 Mandatory

bank address

bankAddressLine2

 string

 Mandatory

bank address

payeeNickName

 string

 Mandatory

payee nick name

zipCode

 string

 Mandatory

zip code

country

 string

 Mandatory

country

fromAccountNumber

 string

 Mandatory

from account number

payeeType

 string

 Mandatory

payee type

payeeName

 string

 Mandatory

payee name

payeeCurrency

 string

 Mandatory

payee currency

bankName

 string

 Mandatory

bank name

cityName

 string

 Mandatory

city name

wireTemplateExecution_id

 string

 Mandatory

wire template execution id

state

 string

 Mandatory

state

payeeAccountNumber

 string

 Mandatory

payee account number

amount

 string

 Mandatory

amount

onetime_id

 string

 Mandatory

one time id

bankState

 string

 Mandatory

bank state

payeeAddressLine1

 string

 Mandatory

payee address

payeeAddressLine2

 string

 Mandatory

payee address

wireAccountType

 string

 Mandatory

wire account type

transactionId

 string

 Mandatory

transaction id

bankCity

 string

 Mandatory

bank city

transactionType

 string

 Mandatory

transaction type

routingNumber

 string

 Mandatory

routing number

confirmationNumber

 string

 Mandatory

confirmation number

status

 string

 Mandatory

status

bulkWireFileID

 string

 Mandatory

Bulk wire file ID

transactionDate

 string

 Mandatory

Transaction date

notes

 string

 Mandatory

Notes

swiftCode

 string

 Mandatory

Swift code

internationalRoutingCode

 string

 Mandatory

International Routing code

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Thursday, May 30, 2024 11:36:39 AM IST