Temenos Digital
R24 AMR | Min(s) read

Wire Payee

The following APIs are common for both Retail Banking and SME Banking.

Name Description Introduced In
createWireTransfersPayee This API creates and stores a Wire Transfer payee for an authorized user 2020.04
deleteWireTransfersPayee This API deletes the Wire Transfer payee based on the ID provided by the authorized logged in user. 2020.04
editWireTransfersPayee This API edits the Wire Transfer payee details for an authorized user. 2020.04
getWireTransfersPayee This API retrieves all the domestic and international Wire Transfer payee details for an authorized user. 2020.04
getUserWiredTransactions This API retrieves the list of Wire Transfers. 2021.10
getRecipientWireTransaction This API retrieves the list of Wire Transfers to a wire transfer payee. 2021.10
DomesticWireTransfer This API allows the user to perform a domestic wire transfer. 2020.04
InternationalWireTransfer This API allows the user to perform an international wire transfer. 2020.04
Object Data Models This Object Data Model describes the parameter name and other attribute details for Wire Payee.  
 
Description: This API creates and stores a Wire Transfer payee for an authorized user
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/createWireTransfersPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Payload for the Domestic Wire Transfer Payee

Parameters

payeeNickName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

payeeAccountNumber (Mandatory)

Specifies the account number of the payee that the user types on the screen.

payeeName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

zipCode (Mandatory)

Specifies the zip code of the payee's location that the user types on the screen.

cityName (Mandatory)

Specifies the name of the city that the user types on the screen.

state (Mandatory)

Specifies the name of the state that the user types on the screen.

addressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

addressLine2

Specifies the second line of address that the user types on the screen.

type (Mandatory)

Specifies the type of payee (Individual/ Business).

country (Mandatory)

Specifies the name of the country that the user types on the screen.

bankName (Mandatory)

Specifies the name of the bank that the user types on the screen.

bankAddressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

bankAddressLine2

Specifies the second line of address that the user types on the screen.

bankCity (Mandatory)

Specifies the name of city where the bank is located that the user typed on the screen.

bankState (Mandatory)

Specifies name of the state where the bank is located that the user types on the screen

bankZip (Mandatory)

Specifies the zip-code of the bank's location that the user types on the screen.

wireAccountType (Mandatory)

Specifies the type of the wire account (domestic/international).

isBusinessPayee (Mandatory)

Specifies whether the payee is a business user. The value is Boolean. By default, the value for the business user is set to true and for the retail user the value is set to false. In case of combined user, the value is taken from user input.

contractId (Mandatory)

Specifies the unique contract ID.

coreCustomerId (Mandatory)

Specifies the unique customer ID.

routingCode (Mandatory)

Specifies the routing code of the payee.

{
    "payeeNickName": "Scooby",
    "payeeAccountNumber": "123423",
    "payeeName": "user",
    "zipCode": "213454",
    "cityName": "dubai",
    "state": "Encamp",
    "addressLine1": "westCarStreet",
    "addressLine2": "",
    "type": "Individual",
    "country": "United States of America",
    "bankName": "bank",
    "bankAddressLine1": "sothStreet",
    "bankAddressLine2": "",
    "bankCity": "chennai",
    "bankState": "La Massana",
    "bankZip": "123456",
    "wireAccountType": "Domestic",
    "isBusinessPayee": "0",
    "cif": "[{\"contractId\":\"6803408029\",\"coreCustomerId\":\"666666\"}]",
    "routingCode": "12345213"
}

 

Payload for the International Wire Transfer Payee

Parameters

payeeNickName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

payeeAccountNumber (Mandatory)

Specifies the account number of the payee that the user types on the screen.

payeeName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

zipCode (Mandatory)

Specifies the zip code of the payee's location that the user types on the screen.

cityName (Mandatory)

Specifies the name of the city that the user types on the screen.

state (Mandatory)

Specifies the name of the state that the user types on the screen.

addressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

addressLine2

Specifies the second line of address that the user types on the screen.

type (Mandatory)

Specifies the type of payee (Individual/ Business).

country (Mandatory)

Specifies the name of the country that the user types on the screen.

bankName (Mandatory)

Specifies the name of the bank that the user types on the screen.

bankAddressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

bankAddressLine2

Specifies the second line of address that the user types on the screen.

bankCity (Mandatory)

Specifies the name of city where the bank is located that the user typed on the screen.

bankState (Mandatory)

Specifies name of the state where the bank is located that the user types on the screen

bankZip (Mandatory)

Specifies the zip-code of the bank's location that the user types on the screen.

wireAccountType (Mandatory)

Specifies the type of the wire account (domestic/international).

isBusinessPayee (Mandatory)

Specifies whether the payee is a business user. The value is Boolean. By default, the value for the business user is set to true and for the retail user the value is set to false. In case of combined user, the value is taken from user input.

contractId (Mandatory)

Specifies the unique contract ID.

coreCustomerId (Mandatory)

Specifies the unique customer ID.

swiftCode (Mandatory)

Specifies the swift code of the payee for international transactions.

internationalRoutingCode (Mandatory)

Specifies the routing code for international payee.

{
    "payeeNickName": "nickel",
    "payeeAccountNumber": "989898",
    "payeeName": "nickel",
    "zipCode": "123456",
    "cityName": "chennai",
    "state": "Bohol",
    "addressLine1": "address12",
    "addressLine2": "address2",
    "type": "Individual",
    "country": "Philippines",
    "bankName": "bankname",
    "bankAddressLine1": "bankaddress1",
    "bankAddressLine2": "bankaddress1",
    "bankCity": "cityname",
    "bankState": "Ordino",
    "bankZip": "123456",
    "wireAccountType": "International",
    "isBusinessPayee": "0",
    "cif": "[{\"contractId\":\"5907209575\",\"coreCustomerId\":\"800155\"}]",
    "swiftCode": "DRESDEFF",
    "internationalRoutingCode": "123443"
}
Response:

Response for the Domestic Wire Transfer Payee

Parameters

payeeId(Mandatory)

Specifies the unique ID of the Wire Transfer payee.

{
    "payeeId": "53509722",
    "opstatus": 0,
    "httpStatusCode": 0
}

Payload for the International Wire Transfer Payee

Parameters

payeeId(Mandatory)

Specifies the unique ID of the Wire Transfer payee.

{
    "payeeId": "71044656",
    "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/dbpPayeeServices/createWireTransfersPayee

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

payeeNickName

payeeNickName

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeName

payeeName

NA

NA

zipCode

zipCode

NA

NA

cityName

cityName

NA

NA

state

state

NA

NA

country

country

NA

NA

bankName

bankName

NA

NA

bankCity

bankCity

NA

NA

bankState

bankState

NA

NA

wireAccountType

wireAccountType

NA

NA

contractId

contractId

NA

NA

coreCustomerId

coreCustomerId

NA

NA

routingCode

routingCode

NA

NA
 
Description: This API deletes the Wire Transfer payee based on the ID provided by the authorized logged in user.
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/deleteWireTransfersPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

payeeId (Mandatory)

Specifies the unique ID of the Wire Transfer payee.

{
    "payeeId": "68141699"
}
Response:

Parameters

/payeeId(Mandatory)

Specifies the unique ID of the Wire Transfer payee.

/isWiredRecepient(Mandatory)

Specifies whether the recipient is a wired recipient. The value is Boolean.

{
    "payeeId": "68141699",
    "isWiredRecepient": "true",
    "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/dbpPayeeServices/deleteWireTransfersPayee

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

isWiredRecepient

isWiredRecepient

NA

NA
 
Description: This API edits the Wire Transfer payee details for an authorized user.
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/editWireTransfersPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

payeeName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

zipCode (Mandatory)

Specifies the zip code of the payee's location that the user types on the screen.

cityName (Mandatory)

Specifies the name of the city that the user types on the screen.

state (Mandatory)

Specifies the name of the state that the user types on the screen.

addressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

addressLine2 (Mandatory)

Specifies the second line of address that the user types on the screen.

type (Mandatory)

Specifies the type of payee (Individual/ Business).

country (Mandatory)

Specifies the name of the country that the user types on the screen.

payeeId (Mandatory)

Specifies the unique ID of the payee whose details must be edited.

wireAccountType (Mandatory)

Specifies the type of the wire account (domestic/international).

routingCode (Mandatory)

Specifies the routing code of the payee.

internationalRoutingCode (Mandatory)

Specifies the routing code for international payee.

payeeNickName (Mandatory)

Specifies the nick name of the payee that the user types on the screen.

accountNumber (Mandatory)

Specifies the account number of the payee that the user types on the screen.

bankName (Mandatory)

Specifies the name of the bank that the user types on the screen.

bankAddressLine1 (Mandatory)

Specifies the first line of address that the user types on the screen.

bankAddressLine2 (Mandatory)

Specifies the second line of address that the user types on the screen.

bankCity (Mandatory)

Specifies the name of city where the bank is located that the user typed on the screen.

bankState (Mandatory)

Specifies name of the state where the bank is located that the user types on the screen

bankZip (Mandatory)

Specifies the zip-code of the bank's location that the user types on the screen.

isBusinessPayee (Mandatory)

Specifies whether the payee is a business user. The value is Boolean. By default, the value for the business user is set to true and for the retail user the value is set to false. In case of combined user, the value is taken from user input.

iban (Mandatory)

Specifies the International Bank Account Number of the user.

cif (Mandatory)

Specifies the cif number.

{
    "payeeName": "Testusers",
    "zipCode": "84893",
    "cityName": "TestCity",
    "state": "La Massana",
    "addressLine1": "Test Line1",
    "addressLine2": "",
    "type": "Individual",
    "country": "United States of America",
    "payeeId": "68141699",
    "wireAccountType": "Domestic",
    "routingCode": "489303004",
    "internationalRoutingCode": "",
    "accountNumber": "39002449",
    "payeeNickName": "TestNick",
    "bankName": "TestBank",
    "bankAddressLine1": "TBl1",
    "bankAddressLine2": "TBl2",
    "bankCity": "TBC",
    "bankState": "Andorra la Vella",
    "bankZip": "488493",
    "isBusinessPayee": "0",
    "iban": "",
    "cif": "[{\"contractId\":\"5907209575\",\"coreCustomerId\":\"800155\"}]"
}
Response:

Parameters

/payeeId(Mandatory)

Specifies the unique ID of the Wire Transfer payee.

{
    "payeeId": "68141699",
    "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/dbpPayeeServices/editWireTransfersPayee

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

zipCode

zipCode

NA

NA

cityName

cityName

NA

NA

state

state

NA

NA

country

country

NA

NA

payeeId

payeeId

NA

NA

wireAccountType

wireAccountType

NA

NA

routingCode

routingCode

NA

NA

internationalRoutingCode

internationalRoutingCode

NA

NA

accountNumber

accountNumber

NA

NA

payeeNickName

payeeNickName

NA

NA

bankName

bankName

NA

NA

contractId

contractId

NA

NA

coreCustomerId

coreCustomerId

NA

NA
 
Description: This API retrieves all the domestic and international Wire Transfer payee details for an authorized user.
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/getWireTransfersPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

sortBy (Mandatory)

Specifies the sorting criteria for the response such as payeeNickName or payeeID. By default, the payees will be sorted according to their payee name.

order (Mandatory)

Specifies the sorting order for the response (Ascending/Descending). By default, the order is set to ascending.

paginationRowLimit (Mandatory)

Specifies the number of rows in a segment for pagination.

{
    "offset": 0,
    "limit": null,
    "sortBy": "nickName",
    "order": "asc",
    "paginationRowLimit": 10
}
Response:

Parameters

Payee

Specifies a JSON object of Wire Transfer payee details in an array.

accountNumber(Mandatory)

Specifies the account number of the payee.

addressLine1(Mandatory)

Specifies the first line of address of the payee.

addressLine2

Specifies the second line of address of the payee.

payeeId(Mandatory)

Specifies the unique ID of the payee.

cityName(Mandatory)

Specifies the name of the city.

payeeName(Mandatory)

Specifies the name of the payee.

payeeNickName(Mandatory)

Specifies the nick name of the payee.

state(Mandatory)

Specifies the state.

zipcode(Mandatory)

Specifies the zip code of the payee.

country(Mandatory)

Specifies the country of the payee.

routingCode(Mandatory)

Specifies the routing code

bankName(Mandatory)

Specifies the name of the bank

bankAddressLine1(Mandatory)

Specifies the first line of address of the bank.

bankAddressLine2

Specifies the second line of address of the bank.

bankcity(Mandatory)

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

bankState(Mandatory)

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

bankZip(Mandatory)

Specifies the zip-code of the bank's location.

contractId (Mandatory)

Specifies the unique contract ID.

coreCustomerId (Mandatory)

Specifies the unique customer ID.

noOfCustomersLinked(Mandatory)

Specifies the total number of customers linked to that payee.

{
    "Payee": [{
        "accountNumber": "123423",
        "addressLine1": "westCarStreet",
        "addressLine2": "",
        "cityName": "dubai",
        "payeeId": "53509722",
        "payeeName": "user",
        "payeeNickName": "Scooby",
        "state": "Encamp",
        "zipCode": "213454",
        "type": "Individual",
        "country": "United States of America",
        "routingCode": "12345213",
        "bankName": "bank",
        "bankAddressLine1": "sothStreet",
        "bankAddressLine2": "",
        "bankCity": "chennai",
        "bankState": "La Massana",
        "bankZip": "123456",
        "wireAccountType": "Domestic",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "noOfCustomersLinked": "1"
    }, {
        "accountNumber": "116785",
        "addressLine1": "Kolkata",
        "addressLine2": "",
        "cityName": "Kolakta",
        "payeeId": "08947396",
        "payeeName": "testUser",
        "payeeNickName": "batman",
        "state": "Ordino",
        "zipCode": "123451",
        "type": "Individual",
        "country": "United States of America",
        "routingCode": "7654432",
        "bankName": "HDfFC",
        "bankAddressLine1": "bangalore",
        "bankAddressLine2": "",
        "bankCity": "bangalore",
        "bankState": "Ordino",
        "bankZip": "124532",
        "wireAccountType": "Domestic",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "noOfCustomersLinked": "1"
    }, {
        "accountNumber": "989898",
        "addressLine1": "streetroad",
        "addressLine2": "",
        "cityName": "dubai",
        "payeeId": "34456377",
        "payeeName": "userman",
        "payeeNickName": "golf",
        "state": "Encamp",
        "zipCode": "123456",
        "type": "Individual",
        "country": "United States of America",
        "routingCode": "1234789",
        "bankName": "bankOfBaroda",
        "bankAddressLine1": "westRoad",
        "bankAddressLine2": "",
        "bankCity": "encamp",
        "bankState": "Encamp",
        "bankZip": "123454",
        "wireAccountType": "Domestic",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "noOfCustomersLinked": "1"
    }],
    "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/dbpPayeeServices/getWireTransfersPayees

Field Mapping

UI field Experience API field MS  API field Transact API field

accountNumber

accountNumber

NA

NA

cityName

cityName

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

payeeNickName

payeeNickName

NA

NA

state

state

NA

NA

country

country

NA

NA

routingCode

routingCode

NA

NA

bankName

bankName

NA

NA

bankAddressLine1

bankAddressLine1

NA

NA

bankCity

bankCity

NA

NA

bankState

bankState

NA

NA

wireAccountType

wireAccountType

NA

NA

coreCustomerId

coreCustomerId

NA

NA

contractId

contractId

NA

NA
 
Description: This API retrieves the list of Wire Transfers.
Method: POST
URL: {base_url}/services/data/v1/TransactionObjects/operations/Activity/getUserWiredTransactions
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

sortBy (Mandatory)

Specifies the sorting criteria for the response such as payeeNickName or payeeID. By default, the payees will be sorted according to their payee name.

order (Mandatory)

Specifies the sorting order for the response (Ascending/Descending). By default, the order is set to ascending.
firstRecordNumber (Mandatory)

Specifies the first record.

lastRecordNumber (Mandatory)

Specifies the last record.

{
    "firstRecordNumber": 0,
    "lastRecordNumber": 10,
    "sortBy": "transactionDate",
    "order": "desc"
}
Response:

Parameters

amount (Mandatory)

Specifies the amount.

fromAccountBalance (Mandatory)

Specifies the balance in from account.
fromAccountName (Mandatory)

Specifies the name of the account.

fromAccountNumber (Mandatory)

Specifies account number.

fromAccountType (Mandatory)

Specifies the type of account.

fromNickName (Mandatory)

Specifies the nick name of the account.
isScheduled (Mandatory)

Specifies whether scheduled or not. This is a Boolean.

payeeAccountNumber (Mandatory)

Specifies payee account number.

payeeId (Mandatory)

Specifies the unique payee ID.

payeeName (Mandatory)

Specifies the name of the payee.
payeeNickName (Mandatory)

Specifies the nick name for the payee.

statusDescription (Mandatory)

Specifies whether transaction is successful or not.

transactionDate (Mandatory)

Specifies the time stamp of the transaction.

transactionId (Mandatory)

Specifies the unique transaction ID.
transactionsNotes (Mandatory)

Specifies the transaction notes.

transactionType (Mandatory)

Specifies the type of transaction.

fee (Mandatory)

Specifies the fees for the transaction.

payeeCurrency (Mandatory)

Specifies the currency for the payee.
wireAccountType (Mandatory)

Specifies type of the wire account.

country (Mandatory)

Specifies the country name.

bankName (Mandatory)

Specifies the name of the bank.

routingNumber (Mandatory)

Specifies the routing number of the payee.
zipCode (Mandatory)

Specifies the ZIP code of the payee.

cityName (Mandatory)

Specifies the name of the city.

bankAddressLine1 (Mandatory)

Specifies the first line of address.

bankAddressLine2 (Mandatory)

Specifies the second line of bank address
bankCity (Mandatory)

Specifies the city name.

bankZip (Mandatory)

Specifies the bank ZIP code.

payeeType (Mandatory)

Specifies the type of payee.

isPayeeDeleted (Mandatory)

Specifies whether the payee is deleted or not.
amountRecieved (Mandatory)

Specifies the received amount.

serviceName (Mandatory)

Specifies name of the service.

isBusinessPayee (Mandatory)

Specifies whether the payee is a business user. The value is Boolean. By default, the value for the business user is set to true and for the retail user the value is set to false. In case of combined user, the value is taken from user input.

{
    "Transactions": [{
        "amount": "50.00",
        "fromAccountBalance": "29644.99",
        "fromAccountName": "Current Account",
        "fromAccountNumber": "118548",
        "fromAccountType": "Checking",
        "fromNickName": "",
        "isScheduled": "false",
        "payeeAccountNumber": "989898",
        "payeeId": "66140646",
        "payeeName": "nickel",
        "payeeNickName": "nickel",
        "statusDescription": "Successful",
        "transactionDate": "2021-09-22T12:39:08+05:30",
        "transactionId": "66140646",
        "transactionsNotes": "hello",
        "transactionType": "Wire",
        "fee": "0.00",
        "payeeCurrency": "USD",
        "wireAccountType": "Domestic",
        "country": "United States of America",
        "bankName": "HDFC",
        "routingNumber": "123443",
        "zipCode": "1234",
        "cityName": "banglore",
        "bankAddressLine1": "bankd",
        "bankAddressLine2": "address",
        "bankCity": "banglore",
        "bankZip": "1234",
        "payeeType": "Domestic",
        "isPayeeDeleted": "false",
        "amountRecieved": "50",
        "serviceName": "DOMESTIC_WIRE_TRANSFER_CREATE",
        "isBusinessPayee": "0"
    }],
    "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}/v4.0.0/party/customers/$userID/consents?propertyClassId=CDP.CONSENT

Field Mapping

UI field Experience API field MS  API field Transact API field

amount

amount

NA

NA

fromAccountBalance

fromAccountBalance

NA

NA

fromAccountName

fromAccountName

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

fromAccountType

fromAccountType

NA

NA

fromNickName

fromNickName

NA

NA

isScheduled

isScheduled

NA

NA

transactionsNotes

transactionsNotes

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

payeeNickName

payeeNickName

NA

NA

transactionDate

transactionDate

NA

NA

transactionId

transactionId

NA

NA

transactionType

transactionType

NA

NA

payeeCurrency

payeeCurrency

NA

NA

wireAccountType

wireAccountType

NA

NA

country

country

NA

NA

bankName

bankName

NA

NA

routingNumber

routingNumber

NA

NA

cityName

cityName

NA

NA

bankAddressLine1

bankAddressLine1

NA

NA

bankAddressLine2

bankAddressLine2

NA

NA

bankCity

bankCity

NA

NA

bankZip

bankZip

NA

NA

payeeType

payeeType

NA

NA

isPayeeDeleted

isPayeeDeleted

NA

NA

amountRecieved

amountRecieved

NA

NA

serviceName

serviceName

NA

NA

fee

fee

NA

NA
 
Description: This API retrieves the list of Wire Transfers.
Method: POST
URL: {base_url}/services/data/v1/TransactionObjects/operations/Activity/getRecipientWireTransaction
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

payeeId (Mandatory)

Specifies the unique payee ID.

{
    "payeeId": "68141699",
    "limit": 12
}
Response:

Parameters

amount (Mandatory)

Specifies the amount.

amountTransferedTillNow (Mandatory)

Specifies the balance in from account.
description (Mandatory)

Specifies the name of the account.

fromAccountBalance (Mandatory)

Specifies account number.

fromAccountName (Mandatory)

Specifies the type of account.

fromAccountNumber (Mandatory)

Specifies the nick name of the account.
fromNickName (Mandatory)

Specifies whether scheduled or not. This is a Boolean.

isScheduled (Mandatory)

Specifies payee account number.

payeeId (Mandatory)

Specifies the unique payee ID.

payeeName (Mandatory)

Specifies the name of the payee.
statusDescription (Mandatory)

Specifies the nick name for the payee.

toAccountName (Mandatory)

Specifies whether transaction is successful or not.

transactionDate (Mandatory)

Specifies the time stamp of the transaction.

transactionId (Mandatory)

Specifies the unique transaction ID.
transactionsNotes (Mandatory)

Specifies the transaction notes.

payeeCurrency (Mandatory)

Specifies the currency for the payee.
wireAccountType (Mandatory)

Specifies type of the wire account.

country (Mandatory)

Specifies the country name.

bankName (Mandatory)

Specifies the name of the bank.

zipCode (Mandatory)

cityName (Mandatory)

Specifies name of the city.

state (Mandatory)

Specifies the ZIP code of the payee.

bankAddressLine1 (Mandatory)

Specifies the first line of address.

bankAddressLine2 (Mandatory)

Specifies the second line of bank address
bankCity (Mandatory)

Specifies the city name.

bankstate (Mandatory)

Specifies the name of the city.

bankZip (Mandatory)

Specifies the bank ZIP code.

isPayeeDeleted (Mandatory)

Specifies whether the payee is deleted or not.
amountRecieved (Mandatory)

Specifies the received amount.

serviceName (Mandatory)

Specifies name of the service.

fee (Mandatory)

Specifies the fees for the transaction.

{
    "Transactions": [{
        "amount": "33.0",
        "amountTransferedTillNow": "33.0",
        "description": "Wire Transfer Successful",
        "fromAccountBalance": "23880.99",
        "fromAccountName": "Current Account",
        "fromAccountNumber": "118656",
        "fromNickName": "",
        "isScheduled": "false",
        "payeeId": "68141699",
        "payeeName": "Test",
        "statusDescription": "Successful",
        "toAccountName": "",
        "transactionDate": "2021-09-14T20:02:18",
        "transactionId": "68141699",
        "transactionsNotes": "tdest",
        "payeeCurrency": "EUR",
        "wireAccountType": "Domestic",
        "country": "United States of America",
        "bankName": "TestBank",
        "zipCode": "84893",
        "cityName": "TestCity",
        "state": "La Massana",
        "bankAddressLine1": "TBl1",
        "bankAddressLine2": "TBl2",
        "bankCity": "TBC",
        "bankState": "Andorra la Vella",
        "bankZip": "488493",
        "isPayeeDeleted": "false",
        "amountRecieved": "33",
        "fee": "0.00",
        "serviceName": "DOMESTIC_WIRE_TRANSFER_CREATE"
    }],
    "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/InfinityTransactionServices/getRecipientWireTransaction

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

amount

amount

NA

NA

amountTransferedTillNow

amountTransferedTillNow

NA

NA

fromAccountBalance

fromAccountBalance

NA

NA

fromAccountName

fromAccountName

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

fromNickName

fromNickName

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

toAccountName

toAccountName

NA

NA

transactionDate

transactionDate

NA

NA

transactionId

transactionId

NA

NA

payeeCurrency

payeeCurrency

NA

NA

wireAccountType

wireAccountType

NA

NA

bankName

bankName

NA

NA

cityName

cityName

NA

NA

bankCity

bankCity

NA

NA

bankState

bankState

NA

NA

bankZip

bankZip

NA

NA

amountRecieved

amountRecieved

NA

NA

fee

fee

NA

NA

serviceName

serviceName

NA

NA
 
Description: This API is used to perform a domestic wire transfer.
Method: POST
URL: {base_url}/services/data/v1/TransactionObjects/operations/Transaction/DomesticWireTransfer
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body 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.

payeeAccountNumber(Mandatory)

Specifies the account number to which the amount must be credited.

payeeAddressLine1(Mandatory)

Specifies the first line of address of the payee.

payeeName(Mandatory)

Specifies the name of the payee.

payeeNickName(Mandatory)

Specifies the nick name of the payee.

transactionsNotes(Mandatory)

Specifies additional information about the transaction.

transactionType(Mandatory)

Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer.

payeeCurrency(Mandatory)

Specifies the currency that the payee uses for performing the transaction.

transactionCurrency(Mandatory)

Specifies the transaction currency that the payee uses for performing the transaction

wireAccountType(Mandatory)

Specifies the type of wire account (Domestic/International).

bankName(Mandatory)

Specifies the name of the bank.

routingNumber(Mandatory)

Specifies the routing number.

zipCode(Mandatory)

Specifies the zip code of the payee.

cityName(Mandatory)

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

state(Mandatory)

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

bankAddressLine1(Mandatory)

Specifies the first line of address of the payee.

bankAddressLine2(Mandatory)

Specifies the second line of address of the payee.

bankCity(Mandatory)

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

bankState(Mandatory)

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

bankZip(Mandatory)

Specifies the zip code of the bank.

payeeType(Mandatory)

Specifies the type of payee.

payeeAddressLine2(Mandatory)

Specifies the second line of address of the payee.

{
    "payeeId": "26911283",
    "amount": "1.00",
    "fromAccountNumber": "118567",
    "transactionsNotes": "",
    "transactionType": "Wire",
    "payeeCurrency": "USD",
    "transactionCurrency": "USD",
    "payeeName": "dgfnick",
    "payeeNickName": "accountNickname1",
    "payeeAccountNumber": "1234536",
    "payeeAddressLine1": "recipientAddressLine11",
    "wireAccountType": "Domestic",
    "bankName": "recipientBank1",
    "routingNumber": "985678",
    "zipCode": "500081",
    "cityName": "Hyderabad",
    "state": "Ordino",
    "bankAddressLine1": "Bankaddress1",
    "bankAddressLine2": "bankaddressline21",
    "bankCity": "Hyderabad",
    "bankState": "Ordino",
    "bankZip": "500042",
    "payeeType": "Individual",
    "payeeAddressLine2": "recipientAddressline21"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique ID generated for the Bill Pay transfer..

amount(Mandatory)

Specifies the amount that is transferred between the two accounts.

bankAddressLine1(Mandatory)

Specifies the first line of address of the payee.

bankAddressLine2(Mandatory)

Specifies the second line of address of the payee.

bankName(Mandatory)

Specifies the name of the bank.

bankCity(Mandatory)

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

bankState(Mandatory)

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

bankZip(Mandatory)

Specifies the zip code of the bank.

cityName(Mandatory)

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

fromAccountNumber(Mandatory)

Specifies the account number from which the amount must be debited.

payeeAccountNumber(Mandatory)

Specifies the account number to which the amount must be credited.

payeeAddressLine1(Mandatory)

Specifies the first line of address of the payee.

payeeAddressLine2(Mandatory)

Specifies the second line of address of the payee.

payeeCurrency(Mandatory)

Specifies the currency in which payee is paying.

payeeName(Mandatory)

Specifies the name of the payee.

payeeNickName(Mandatory)

Specifies the nickname of the payee.

payeeType(Mandatory)

Specifies the type of payee.

routingNumber(Mandatory)

Specifies the routing number.

state(Mandatory)

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

transactionsNotes(Mandatory)

Specifies additional information about the transaction.

transactionType(Mandatory)

Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer.

wireAccountType(Mandatory)

Specifies the type of wire account (Domestic/International).

zipCode(Mandatory)

Specifies the zip code of the payee.

serviceName(Mandatory)

Specifies the name of the service that is used for performing Bill Pay transfer.

serviceCharge(Mandatory)

Specifies the service charges for this transaction.

transactionAmount (Mandatory)

Specifies the amount for the transaction.
{
    "referenceId": "20862",
    "opstatus": 0,
    "httpStatusCode": 0,
    "status": "Sent",
    "message": "Success! Your transaction has been completed",
    "amount": "1",
    "fromAccountNumber": "118567",
    "payeeAccountNumber": "1234536",
    "payeeCurrency": "USD",
    "payeeId": "26911283",
    "payeeName": "dgfnick",
    "transactionsNotes": "",
    "transactionType": "Wire",
    "serviceName": "DOMESTIC_WIRE_TRANSFER_CREATE",
    "serviceCharge": "0.0",
    "transactionAmount": "1.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/CreateDomesticWireTransaction

Field Mapping

UI field Experience API field MS  API field Transact API field

referenceId

referenceId

NA

NA

amount

amount

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeCurrency

payeeCurrency

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

transactionsNotes

transactionsNotes

NA

NA

transactionType

transactionType

NA

NA

serviceName

serviceName

NA

NA

serviceCharge

serviceCharge

NA

NA

transactionAmount

transactionAmount

NA

NA
 
Description: This API is used to perform a international wire transfer.
Method: POST
URL: {base_url}/services/data/v1/TransactionObjects/operations/Transaction/InternationalWireTransfer
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body 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.

payeeAccountNumber(Mandatory)

Specifies the account number to which the amount must be credited.

payeeAddressLine1(Mandatory)

Specifies the first line of address of the payee.

payeeName(Mandatory)

Specifies the name of the payee.

payeeNickName(Mandatory)

Specifies the nickname of the payee.

transactionsNotes(Mandatory)

Specifies additional information about the transaction.

transactionType(Mandatory)

Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer.

payeeCurrency(Mandatory)

Specifies the currency that the payee uses for performing the transaction.

transactionCurrency(Mandatory)

Specifies the transaction currency that the payee uses for performing the transaction.

wireAccountType(Mandatory)

Specifies the type of wire account (Domestic/International).

country(Mandatory)

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

bankName(Mandatory)

Specifies the name of the bank.

routingNumber(Mandatory)

Specifies the international routing number.

zipCode(Mandatory)

Specifies the zip code of the payee.

cityName(Mandatory)

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

state(Mandatory)

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

bankAddressLine1(Mandatory)

Specifies the first line of address of the payee.

bankAddressLine2(Mandatory)

Specifies the second line of address of the payee.

bankCity(Mandatory)

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

bankState(Mandatory)

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

bankZip(Mandatory)

Specifies the zip code of the bank.

payeeType(Mandatory)

Specifies the type of payee.

payeeAddressLine2(Mandatory)

Specifies the second line of address of the payee.

{
    "payeeId": "96259492",
    "amount": "1.00",
    "fromAccountNumber": "118567",
    "transactionsNotes": "",
    "transactionType": "Wire",
    "payeeCurrency": "USD",
    "transactionCurrency": "USD",
    "payeeName": "tom",
    "payeeNickName": "jerry",
    "payeeAccountNumber": "676767",
    "payeeAddressLine1": "address1",
    "wireAccountType": "International",
    "bankName": "bank",
    "routingNumber": "765432",
    "zipCode": "123321",
    "cityName": "chennai",
    "state": "Khulna",
    "bankAddressLine1": "address1",
    "bankAddressLine2": "address2",
    "bankCity": "chennai",
    "bankState": "Encamp",
    "bankZip": "123321",
    "payeeType": "Individual",
    "payeeAddressLine2": "address2"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique ID generated for the Bill Pay transfer..

amount(Mandatory)

Specifies the amount that is transferred between the two accounts.

bankAddressLine1(Mandatory)

Specifies the first line of address of the payee.

bankAddressLine2(Mandatory)

Specifies the second line of address of the payee.

bankName(Mandatory)

Specifies the name of the bank.

bankCity(Mandatory)

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

bankState(Mandatory)

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

bankZip(Mandatory)

Specifies the zip code of the bank.

cityName(Mandatory)

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

fromAccountNumber (Mandatory)

Specifies the account number from which the amount must be debited./

payeeAccountNumber(Mandatory)

Specifies the account number to which the amount must be credited.

payeeAddressLine1(Mandatory)

Specifies the first line of address of the payee.

payeeAddressLine2(Mandatory)

Specifies the second line of address of the payee.

/payeeCurrency(Mandatory)

Specifies the currency of the payee.

/payeeName(Mandatory)

Specifies the name of the payee.

/payeeNickName(Mandatory)

Specifies the nickname of the payee.

/payeeType(Mandatory)

Specifies the type of payee.

routingNumber(Mandatory)

Specifies the routing number.

state(Mandatory)

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

transactionsNotes(Mandatory)

Specifies additional information about the transaction.

transactionType(Mandatory)

Specifies whether the transaction type is an internal transfer, an external transfer, or an international transfer.

wireAccountType(Mandatory)

Specifies the type of wire account (Domestic/International).

zipCode(Mandatory)

Specifies the zip code of the payee.

serviceName(Mandatory)

Specifies the name of the service that is used for performing Bill Pay transfer.

serviceCharge(Mandatory)

Specifies the service charge for this transaction.

transactionAmount (Mandatory)

Specifies the amount.
{
    "referenceId": "20863",
    "opstatus": 0,
    "httpStatusCode": 0,
    "status": "Sent",
    "message": "Success! Your transaction has been completed",
    "amount": "1",
    "fromAccountNumber": "118567",
    "payeeAccountNumber": "676767",
    "payeeCurrency": "USD",
    "payeeId": "96259492",
    "payeeName": "tom",
    "transactionsNotes": "",
    "transactionType": "Wire",
    "serviceName": "INTERNATIONAL_WIRE_TRANSFER_CREATE",
    "serviceCharge": "0.0",
    "transactionAmount": "1.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/CreateInternationalWireTransaction

Field Mapping

UI field Experience API field MS  API field Transact API field

referenceId

referenceId

NA

NA

amount

amount

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeCurrency

payeeCurrency

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

transactionsNotes

transactionsNotes

NA

NA

transactionType

transactionType

NA

NA

serviceName

serviceName

NA

NA

serviceCharge

serviceCharge

NA

NA

transactionAmount

transactionAmount

NA

NA
 
Parameter Name DataType Optional/Mandatory Description

sortBy

 string

 Mandatory

sort by

order

string

Mandatory

order

paginationRowLimit

string

Mandatory

page row limit

accountNumber

string

Mandatory

Account number

addressLine1

string

Mandatory

address

addressLine2

 string

 Mandatory

address

payeeId

string

Mandatory

Payee Id

cityName

 string

 Mandatory

City name

payeeName

string

Mandatory

Payee name

payeeNickName

string

Mandatory

Payee nick name

state

string

Mandatory

state

zipCode

 string

 Mandatory

Zip code

country

string

Mandatory

Country

type

string

Mandatory

type

routingCode

string

Mandatory

Routing code

bankName

string

Mandatory

Bank name

bankAddressLine1

 string

 Mandatory

Bank address

bankAddressLine2

string

Mandatory

Bank address

bankCity

string

Mandatory

Bank City

bankState

 string

 Mandatory

Bank state

bankZip

string

Mandatory

Bank Zip code

wireAccountType

string

Mandatory

Wire Account type

noOfCustomersLinked

string

Mandatory

Number of customers linked

coreCustomerId

string

Mandatory

Core customer id

contractId

string

Mandatory

contract id

payeeAccountNumber

string

Mandatory

Payee Account number

isBusinessPayee

string

Mandatory

IS Bussiness Payee

swiftCode

string

Mandatory

Swift Code

internationalRoutingCode

string

Mandatory

International Routing code
 
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

amount

string

Mandatory

amount

fromAccountBalance

string

Mandatory

from account balance

fromAccountName

string

Mandatory

from account person name

fromAccountNumber

string

Mandatory

from account number

fromAccountType

string

Mandatory

from account type

fromNickName

string

Mandatory

from nick name

isScheduled

string

Mandatory

Is scheduled

payeeId

string

Mandatory

payee id

payeeName

string

Mandatory

payee name

payeeAccountNumber

string

Mandatory

payee account number

payeeNickName

string

Mandatory

payee nick name

statusDescription

string

Mandatory

status description

transactionDate

string

Mandatory

transaction date

transactionId

string

Mandatory

transaction id

transactionsNotes

string

Mandatory

transaction notes

transactionType

string

Mandatory

transaction type

fee

string

Mandatory

fee

payeeCurrency

string

Mandatory

payee currency

wireAccountType

string

Mandatory

wire account type

country

string

Mandatory

country

bankName

string

Mandatory

bank name

routingNumber

string

Mandatory

routing number

zipCode

string

Mandatory

zip code

cityName

string

Mandatory

city name

bankAddressLine1

string

Mandatory

Bank address

bankAddressLine2

string

Mandatory

Bank address

bankCity

string

Mandatory

Bank city

bankZip

string

Mandatory

Bank zip

payeeType

string

Mandatory

Payee type

isPayeeDeleted

string

Mandatory

Is Payee deleted

amountRecieved

string

Mandatory

amount received

serviceName

string

Mandatory

service name

isBusinessPayee

string

Mandatory

Is Bussiness payee

amountTransferedTillNow

string

Mandatory

amount transferred till now

description

string

Mandatory

description

toAccountName

string

Mandatory

to account name

state

string

Mandatory

state

bankState

string

Mandatory

bank state

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

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