Temenos Digital
Updated On 09 January 2024 | Min(s) read

Bill Pay Payee

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

Name Description Introduced In
searchBillerByName This API helps user to do a keyword search and system retrieves the bill payees matching information. 2021.10
createBillPayPayee This API creates and stores a Bill Pay payee in DBX DB for a user who has access to multiple customer IDs or a single CIF in the contract. 2020.04
deleteBillPayPayee This API deletes the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs or a single CIF in the contract. 2020.04
updateBillPayPayee This API updates the information of the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs in the contract. 2020.04
getBillPayPayees This API retrieves information about the the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs in the contract. 2020.04
getPayeePayments This API helps user to view Payments made to the bill pay payee. 2021.10
createPayment This API helps user to create payments to existing bill pay payee or adhoc payment to bill pay payee. 2021.10
createPayment_bulk This API helps user to create payments to multiple bill pay payee. 2021.10
getCompletedPayments This API helps user to retrieve bill payments whose execution is same day as the day on which user submitted the payment. 2021.10
getScheduledPayments This API helps user to view future dated payments and recurring payments. 2021.10
updatePayment This API helps user to update onetime or amend recurring bill pay payments. 2021.10
updatePayment_delete This API helps to stop recurring bill pay payment. 2021.10
Payment_ebills This API helps to view ebills with their details. 2021.10
Object Data Models This Object Data Model describes the parameter name and other attribute details for Bill Pay Payee.  
 
Description: This API helps user to do a keyword search and system retrieves the bill payees matching information.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Biller/searchBillerByName
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

searchString (Mandatory)

Specifies the search string.

limit (Mandatory)

Specifies the max character limit.

{
"searchString":"s",
"limit":5
}
Response:

Parameters

Biller

Specifies a JSON object of Biller details in an array.

accountNumber

Specifies the account number of the biller.

address

Specifies the address of the biller.

billerCategoryId_id

Specifies the unique category ID of the biller.

billerCategoryName

Specifies the unique biller category name.

billerName

Specifies name of the biller..

city

Specifies the name of the city.

ebillSupport

Specifies whether the biller have ebillSupport (True/False).

id

Specifies the unique ID of biller.

state

Specifies the state where the biller is located.

zipCode

Specifies the zip-code of the billers location.

{
    "Biller": [{
        "accountNumber": "371287190099683",
        "address": "1801 66th Ave, Suite 103A, Plantation, FL 33313",
        "billerCategoryId": "1",
        "billerCategoryName": "Credit Card",
        "billerName": "American Express Credit Card",
        "city": "Orlando",
        "ebillSupport": "true",
        "id": "2",
        "state": "Florida",
        "zipCode": "678901"
    }, {
        "accountNumber": "82365828",
        "address": "44 Shirley Ave. , West Chicago, IL 60185",
        "billerCategoryId": "3",
        "billerCategoryName": "Utilities",
        "billerName": "City Utilities Company",
        "city": "West Chicago",
        "ebillSupport": "true",
        "id": "7",
        "state": "Illinois",
        "zipCode": "371256"
    }, {
        "accountNumber": "20986743",
        "address": "514 S. Magnolia St. , Orlando, FL 32806",
        "billerCategoryId": "3",
        "billerCategoryName": "Utilities",
        "billerName": "City Water Works",
        "city": "Orlando",
        "ebillSupport": "true",
        "id": "8",
        "state": "Florida",
        "zipCode": "813957"
    }, {
        "accountNumber": "91837583",
        "address": "123 6th St. , Chevy Chase, MD 20815",
        "billerCategoryId": "4",
        "billerCategoryName": "Insurance",
        "billerName": "AXA Life Insurance",
        "city": "Chevy",
        "ebillSupport": "true",
        "id": "9",
        "state": "Maryland",
        "zipCode": "923865"
    }, {
        "accountNumber": "28396538",
        "address": "70 Bowman St., South Windsor, CT 06074",
        "billerCategoryId": "4",
        "billerCategoryName": "Insurance",
        "billerName": "American Family Insurance",
        "city": "Windsor",
        "ebillSupport": "true",
        "id": "10",
        "state": "Connecticut",
        "zipCode": "186435"
    }],
    "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/searchBillerByName

Field Mapping

UI field Experience API field MS  API field Transact API field

accountNumber

accountNumber

NA

NA

address

address

NA

NA

billerCategoryId

billerCategoryId

NA

NA

billerCategoryName

billerCategoryName

NA

NA

billerName

billerName

NA

NA

city

city

NA

NA

ebillSupport

ebillSupport

NA

NA

id

id

NA

NA

state

state

NA

NA

zipCode

zipCode

NA

NA
 
Description: This API creates and stores a Bill Pay payee in DBX DB for a user who has access to multiple customer IDs or a single CIF in the contract.
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/createBillPayPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Payload for Create Bill Pay Payee by searching from a list

Parameters

accountNumber (Mandatory)

Specifies the account number that is associated with the Bill Pay payee.

billerId (Mandatory)

Specifies the unique ID of the biller.

cityName (Mandatory)

Specifies the name of the city.

companyName (Mandatory)

Specifies the name of the company.

nameOnBill

Specifies the name of the payee that is present on the bill.

payeeNickName (Mandatory)

Specifies the nick name of the payee.

country (Mandatory)

Specifies the name of the country .

state (Mandatory)

Specifies the name of the state.

street (Mandatory)

Specifies the name of the street.

addressLine2

Specifies the address of the biller.

zipCode (Mandatory)

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

cif (Mandatory)

Specifies an array of customer information details in a JSON object.

isBusinessPayee (Mandatory)

Specifies whether payee is a business account.

phone

Specifies the phone number of biller.

Notes

Specifies the notes of the biller.

contractId (Mandatory)

Specifies the unique contract ID of the biller.

coreCustomerId (Mandatory)

Specifies the unique core customer ID of the biller.

{
    "accountNumber": "116823",
    "street": "BOA, P.O. Box 15019, Wilmington, DE 19850-5019",
    "addressLine2": "",
    "cityName": "Wilmington",
    "payeeNickName": "Bank Of America Credit Card",
    "zipCode": "432156",
    "companyName": "Bank Of America Credit Card",
    "isBusinessPayee": "0",
    "nameOnBill": "Temenos Temenos",
    "billerId": "3",
    "phone": "",
    "state": "Delaware",
    "country": "",
    "notes": "",
    "cif": "[{\"contractId\":\"6803408029\",\"coreCustomerId\":\"666666\"}]"
}

Payload for Create Bill Pay Payee by Entering Bill Pay Payee info

Parameters

accountNumber (Mandatory)

Specifies the account number that is associated with the Bill Pay payee.

billerId

Specifies the unique ID of the biller.

cityName (Mandatory)

Specifies the name of the city.

companyName (Mandatory)

Specifies the name of the company.

nameOnBill (Mandatory)

Specifies the name of the payee that is present on the bill.

payeeNickName

Specifies the nick name of the payee.

country (Mandatory)

Specifies the name of the country .

state (Mandatory)

Specifies the name of the state.

street (Mandatory)

Specifies the name of the street.

addressLine2 (Mandatory)

Specifies the address of the biller.

zipCode (Mandatory)

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

cif (Mandatory)

Specifies an array of customer information details in a JSON object.

isBusinessPayee

Specifies whether payee is a business account.

phone

Specifies the phone number of biller.

Notes

Specifies the notes of the biller.

contractId (Mandatory)

Specifies the unique contract ID of the biller.

coreCustomerId (Mandatory)

Specifies the unique core customer ID of the biller.

{
    "accountNumber": "116898",
    "street": "Banglore",
    "addressLine2": "kormangala",
    "cityName": "Banglore",
    "payeeNickName": "ComCast",
    "zipCode": "432156",
    "companyName": "ComCast",
    "isBusinessPayee": "0",
    "nameOnBill": "Temenos Temenos",
    "billerId": "",
    "phone": "",
    "state": "Karnataka",
    "country": "India",
    "notes": "",
    "cif": "[{\"contractId\":\"6803408029\",\"coreCustomerId\":\"666666\"}]"
}
Response:

Response for Create Bill Pay Payee by searching from a list

Parameters

payeeId

Specifies the unique ID of the created payee.

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

Response for Create Bill Pay Payee by Entering Bill Pay Payee info

Parameters

payeeId

Specifies the unique ID of the created payee.

{
    "payeeId": "50724207",
    "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/createBillPayPayee

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

accountNumber

accountNumber

NA

NA

payeeNickName

payeeNickName

NA

NA

cityName

cityName

NA

NA

zipCode

zipCode

NA

NA

companyName

companyName

NA

NA

billerId

billerId

NA

NA

nameOnBill

nameOnBill

NA

NA

state

state

NA

NA

contractId

contractId

NA

NA

contractId

contractId

NA

NA
 
Description: This API deletes the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs or a single CIF in the contract.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Payee_BillPay/deleteBillPayPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Parameters

payeeId (Mandatory)

Specifies the unique ID of the created payee.

{
    "payeeId": "19829707"
}
Response:

Parameters

payeeId(Mandatory)

Specifies the unique ID of the deleted payee.

{
    "payeeId": "19829707",
    "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/deleteBillPayPayee

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
payeeId payeeId NA NA
 
Description: This API updates the information of the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs in the contract.
Method: POST
URL: {base_url}/services/data/v1/PayeeObjects/operations/Recipients/editBillPayPayee
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Payloads for the Update Bill Pay Payee Details

Parameters

payeeId (Mandatory)

Specifies the unique ID of the created payee.

payeeNickName (Mandatory)

Specifies the nick name of the payee.

addressLine1 (Mandatory)

Specifies the first line of address.

addressLine2 (Mandatory)

Specifies the second line of address.

state (Mandatory)

Specifies the name of the state.

country (Mandatory)

Specifies the name of the country.

zipCode (Mandatory)

Specifies the Zip code of the location.

cityName (Mandatory)

Specifies the name of the city.

contractId (Mandatory)

Specifies the unique contractID of the payee.

coreCustomerId (Mandatory)

Specifies the unique corecustomerID of the payee.

{
    "payeeId": "10748294",
    "payeeNickName": "Temenos",
    "addressLine1": "India",
    "addressLine2": "Colony2",
    "state": "Karnataka",
    "country": "India",
    "zipCode": "432156",
    "cityName": "Cheenai",
    "cif": "[{\"contractId\":\"6803408029\",\"coreCustomerId\":\"666666\"}]"
}

 

Payloads for Activate Ebill

Parameters

payeeId (Mandatory)

Specifies the unique ID of the created payee.

EBillEnable (Mandatory)

Specifies the whether eBillEnabled or not. This is a Boolean value.

{
    "payeeId": "19829707",
    "EBillEnable": 1
}

 

Payloads for Deactivate Ebill

Parameters

payeeId (Mandatory)

Specifies the unique ID of the created payee.

EBillEnable (Mandatory)

Specifies the whether eBillEnabled or not. This is a Boolean value.

{
    "payeeId": "19829707",
    "EBillEnable": 0
}
Response:

Response for Update Bill Pay Payee Details

Parameters

payeeId(Mandatory)

Specifies the unique ID of the edited payee.

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

Response for Activate Ebill

Parameters

payeeId(Mandatory)

Specifies the unique ID of the edited payee.
{
    "payeeId": "19829707",
    "opstatus": 0,
    "httpStatusCode": 0
}

Response for Deactivate Ebill

Parameters

payeeId(Mandatory)

Specifies the unique ID of the edited payee.

{
    "payeeId": "19829707",
    "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/editBillPayPayee

Field Mapping

UI field Experience API field MS  API field Transact API field

payeeId

payeeId

NA

NA

payeeNickName

payeeNickName

NA

NA

addressLine1

addressLine1

NA

NA

addressLine2

addressLine2

NA

NA

state

state

NA

NA

country

country

NA

NA

cityName

cityName

NA

NA

contractId

contractId

NA

NA

coreCustomerId

coreCustomerId

NA

NA
 
Description: This API retrieves information about the the Bill Pay payee that is stored in the DBX DB for a user who has access to multiple customer IDs in the contract.
Method: POST
URL: base_url/services/data/v1/BillPay/operations/Payee_BillPay/getBillPayPayees
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization

Body Request:

Payload to Retrieve Bill Pay Payee based on input parameter, order, pagination and sort type

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 starting index of the sorted records that are used in pagination.

sortByType (Mandatory)

Specifies the ending index of the sorted records that are used in pagination.

{
    "offset": 0,
    "limit": 10,
    "sortBy": "payeeNickName",
    "order": "asc",
    "paginationRowLimit": 10,
    "sortByType": "string"
}

 

Payload to Retrieve Bill Pay Payee based on input parameter and order

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.

{
    "sortBy": "payeeNickName",
    "order": "asc"
}

 

Payload to Retrieve Bill Pay Payee based on Search String

Parameters

searchString (Mandatory)

Specifies the search string.

{
    "searchString": "Temenos"
}
Response:

Response to Retrieve Bill Pay Payee based on input parameter, order, pagination and sort type

Parameters

Payee

Specifies a JSON object of Billpay payee details in an array.

accountNumber(Mandatory)

Specifies the account number of the payee.

addressLine1(Mandatory)

Specifies the address line 1 of the biller.

addressLine2(Mandatory)

Specifies the address line 2 of the biller.

billerId(Mandatory)

Specifies the unique billerID of the bill.

billermaster_id(Mandatory)

Specifies an the unique master biller ID.

billid(Mandatory)

Specifies the unique bill ID.

coreCustomerId(Mandatory)

Specifies the unique core customer ID.

contractId(Mandatory)

Specifies the unique contract ID.

cityName(Mandatory)

Specifies the city name.

companyName(Mandatory)

Specifies the company name.

country(Mandatory)

Specifies the name of the country.

eBillStatus(Mandatory)

Specifies whether eBillStatus is active or not active. This is Boolean.

eBillSupport(Mandatory)

Specifies whether eBillSupport is required or not required. This is Boolean.

payeeId(Mandatory)

Specifies the unique payee ID.

isAutoPayEnabled

Specifies whether AutoPayEnabled or not. This is a Boolean

isManuallyAdded

Specifies whether isManuallyAdded or not. This is a Boolean.

isWiredRecepient

Specifies whether biller is a wiredRecepient or not. This is a Boolean.

lastPaidAmount(Mandatory)

Specifies the last Paid Amount.

lastPaidDate(Mandatory)

Specifies the time stamp of the last paid date.

payeeName(Mandatory)

Specifies the payee name of the biller.

nameOnBill(Mandatory)

Specifies the name on the bill.

payeeNickName

Specifies the nick name of the payee.

notes

Specifies the notes for the payee.

phone

Specifies the mobile number of the biller.

state(Mandatory)

Specifies the state name.

transitDays(Mandatory)

Specifies the number of transit days.

userId(Mandatory)

Specifies the the unique userID.

zipCode(Mandatory)

Specifies the Zip Code.

payeeAccountNumber(Mandatory)

Specifies the account number for the payee.

noOfCustomersLinked(Mandatory)

Specifies the total number of customer linked to the biller.

{
    "Payee": [{
        "accountNumber": "9770570525",
        "addressLine1": "Paramsukh",
        "addressLine2": "Colony",
        "billerId": "1",
        "billermaster_id": "1",
        "billid": "0",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "cityName": "Cheenai",
        "companyName": "Prashant Upadhyay",
        "country": "India",
        "eBillStatus": "0",
        "eBillSupport": "true",
        "payeeId": "10748294",
        "isAutoPayEnabled": "false",
        "isManuallyAdded": "false",
        "isWiredRecepient": "false",
        "lastPaidAmount": "26",
        "lastPaidDate": "2021-09-01T05:37:43Z",
        "payeeName": "Prashant Upadhyay",
        "nameOnBill": "",
        "payeeNickName": "Temenos",
        "notes": "",
        "phone": "",
        "state": "TamilNadu",
        "transitDays": "3",
        "userId": "2102609132",
        "zipCode": "432156",
        "payeeAccountNumber": "9770570525",
        "noOfCustomersLinked": "1"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

 

Response to Retrieve Bill Pay Payee based on input parameter and order

arameters

Payee(Mandatory)

Specifies a JSON object of Billpay payee details in an array.

accountNumber(Mandatory)

Specifies the account number of the payee.

addressLine1(Mandatory)

Specifies the address line 1 of the biller.

addressLine2(Mandatory)

Specifies the address line 2 of the biller.

billerId(Mandatory)

Specifies the unique billerID of the bill.

billermaster_id(Mandatory)

Specifies an the unique master biller ID.

billid(Mandatory)

Specifies the unique bill ID.

coreCustomerId(Mandatory)

Specifies the unique core customer ID.

contractId(Mandatory)

Specifies the unique contract ID.

cityName(Mandatory)

Specifies the city name.

companyName(Mandatory)

Specifies the company name.

country(Mandatory)

Specifies the name of the country.

eBillStatus(Mandatory)

Specifies whether eBillStatus is active or not active. This is Boolean.

eBillSupport(Mandatory)

Specifies whether eBillSupport is required or not required. This is Boolean.

payeeId(Mandatory)

Specifies the unique payee ID.

isAutoPayEnabled(Mandatory)

Specifies whether AutoPayEnabled or not. This is a Boolean

isManuallyAdded

Specifies whether isManuallyAdded or not. This is a Boolean.

isWiredRecepient(Mandatory)

Specifies whether biller is a wiredRecepient or not. This is a Boolean.

lastPaidAmount(Mandatory)

Specifies the last Paid Amount.

lastPaidDate(Mandatory)

Specifies the time stamp of the last paid date.

payeeName

Specifies the payee name of the biller.

nameOnBill

Specifies the name on the bill.

payeeNickName(Mandatory)

Specifies the nick name of the payee.

notes

Specifies the notes for the payee.

phone

Specifies the mobile number of the biller.

state(Mandatory)

Specifies the state name.

transitDays(Mandatory)

Specifies the number of transit days.

userId(Mandatory)

Specifies the the unique userID.

zipCode(Mandatory)

Specifies the Zip Code.

payeeAccountNumber(Mandatory)

Specifies the account number for the payee.

noOfCustomersLinked(Mandatory)

Specifies the total number of customer linked to the biller.

{
    "Payee": [{
        "accountNumber": "9770570525",
        "addressLine1": "Paramsukh",
        "addressLine2": "Colony",
        "billerId": "1",
        "billermaster_id": "1",
        "billid": "0",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "cityName": "Cheenai",
        "companyName": "Prashant Upadhyay",
        "country": "India",
        "eBillStatus": "1",
        "eBillSupport": "true",
        "payeeId": "10748294",
        "isAutoPayEnabled": "false",
        "isManuallyAdded": "false",
        "isWiredRecepient": "false",
        "lastPaidAmount": "64",
        "lastPaidDate": "2021-09-01T06:00:34Z",
        "payeeName": "Prashant Upadhyay",
        "nameOnBill": "",
        "payeeNickName": "Temenos",
        "notes": "",
        "phone": "",
        "state": "TamilNadu",
        "transitDays": "3",
        "userId": "2102609132",
        "zipCode": "432156",
        "payeeAccountNumber": "9770570525",
        "noOfCustomersLinked": "1"
    }],
    "opstatus": 0,
    "httpStatusCode": 0
}

 

Response to Retrieve Bill Pay Payee based on Search String

Parameters

Payee

Specifies a JSON object of Billpay payee details in an array.

accountNumber(Mandatory)

Specifies the account number of the payee.

addressLine2

Specifies the address line 2 of the biller.

billerId(Mandatory)

Specifies the unique billerID of the bill.

billermaster_id(Mandatory)

Specifies an the unique master biller ID.

billid

Specifies the unique bill ID.

coreCustomerId(Mandatory)

Specifies the unique core customer ID.

contractId(Mandatory)

Specifies the unique contract ID.

cityName(Mandatory)

Specifies the city name.

companyName(Mandatory)

Specifies the company name.

country

Specifies the name of the country.

eBillStatus(Mandatory)

Specifies whether eBillStatus is active or not active. This is Boolean.

eBillSupport(Mandatory)

Specifies whether eBillSupport is required or not required. This is Boolean.

payeeId(Mandatory)

Specifies the unique payee ID.

isAutoPayEnabled

Specifies whether AutoPayEnabled or not. This is a Boolean

isManuallyAdded

Specifies whether isManuallyAdded or not. This is a Boolean.

isWiredRecepient(Mandatory)

Specifies whether biller is a wiredRecepient or not. This is a Boolean.

lastPaidAmount(Mandatory)

Specifies the last Paid Amount.

lastPaidDate(Mandatory)

Specifies the time stamp of the last paid date.

payeeName(Mandatory)

Specifies the payee name of the biller.

nameOnBill(Mandatory)

Specifies the name on the bill.

payeeNickName(Mandatory)

Specifies the nick name of the payee.

notes

Specifies the notes for the payee.

phone

Specifies the mobile number of the biller.

state

Specifies the state name.

transitDays(Mandatory)

Specifies the number of transit days.

userId(Mandatory)

Specifies the the unique userID.

zipCode(Mandatory)

Specifies the Zip Code.

payeeAccountNumber(Mandatory)

Specifies the account number for the payee.

noOfCustomersLinked(Mandatory)

Specifies the total number of customer linked to the biller.

{
    "Payee": [{
        "accountNumber": "123456",
        "addressLine2": "",
        "billerId": "7",
        "billermaster_id": "7",
        "billid": "0",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "cityName": "West Chicago",
        "companyName": "City Utilities Company",
        "country": "",
        "eBillStatus": "0",
        "eBillSupport": "true",
        "payeeId": "36403588",
        "isAutoPayEnabled": "false",
        "isManuallyAdded": "false",
        "isWiredRecepient": "false",
        "lastPaidAmount": "140",
        "lastPaidDate": "2021-09-01T08:59:25Z",
        "payeeName": "City Utilities Company",
        "nameOnBill": "Temenos Temenos",
        "payeeNickName": "City Utilities Company",
        "notes": "",
        "phone": "",
        "state": "Illinois",
        "transitDays": "3",
        "userId": "2102609132",
        "zipCode": "214365",
        "payeeAccountNumber": "123456",
        "noOfCustomersLinked": "1"
    }, {
        "accountNumber": "9770570525",
        "addressLine1": "India",
        "addressLine2": "Colony2",
        "billerId": "1",
        "billermaster_id": "1",
        "billid": "0",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "cityName": "Cheenai",
        "companyName": "Prashant Upadhyay",
        "country": "India",
        "eBillStatus": "1",
        "eBillSupport": "true",
        "payeeId": "10748294",
        "isAutoPayEnabled": "false",
        "isManuallyAdded": "false",
        "isWiredRecepient": "false",
        "lastPaidAmount": "108",
        "lastPaidDate": "2021-09-01T08:59:25Z",
        "payeeName": "Prashant Upadhyay",
        "nameOnBill": "",
        "payeeNickName": "Temenos",
        "notes": "",
        "phone": "",
        "state": "Karnataka",
        "transitDays": "3",
        "userId": "2102609132",
        "zipCode": "432156",
        "payeeAccountNumber": "9770570525",
        "noOfCustomersLinked": "1"
    }, {
        "accountNumber": "116898",
        "addressLine2": "kormangala",
        "billerId": "1",
        "billermaster_id": "1",
        "billid": "0",
        "cif": "[{\"coreCustomerId\":\"666666\",\"contractId\":\"6803408029\"}]",
        "cityName": "Banglore",
        "companyName": "ComCast",
        "country": "India",
        "eBillStatus": "0",
        "eBillSupport": "true",
        "payeeId": "50724207",
        "isAutoPayEnabled": "false",
        "isManuallyAdded": "false",
        "isWiredRecepient": "false",
        "lastPaidAmount": "24",
        "lastPaidDate": "2021-09-01T08:59:25Z",
        "payeeName": "ComCast",
        "nameOnBill": "Temenos Temenos",
        "payeeNickName": "ComCast",
        "notes": "",
        "phone": "",
        "state": "Karnataka",
        "transitDays": "3",
        "userId": "2102609132",
        "zipCode": "432156",
        "payeeAccountNumber": "116898",
        "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/getBillPayPayees

Field Mapping

UI field Experience API field MS  API field Transact API field

accountNumber

accountNumber

NA

NA

billerId

billerId

NA

NA

billermaster_id

billermaster_id

NA

NA

coreCustomerId

coreCustomerId

NA

NA

contractId

contractId

NA

NA

companyName

companyName

NA

NA

country

country

NA

NA

payeeId

payeeId

NA

NA

lastPaidAmount

lastPaidAmount

NA

NA

lastPaidDate

lastPaidDate

NA

NA

payeeName

payeeName

NA

NA

payeeNickName

payeeNickName

NA

NA

state

state

NA

NA

userId

userId

NA

NA

zipCode

zipCode

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA
 
Description: This API helps user to view Payments made to the bill pay payee.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Payment_BillPayList/getPayeePayments
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

payeeId (Mandatory)

Specifies the unique payee ID.

payeeName (Mandatory)

Specifies the name of the payee.

payeeAccountNumber (Mandatory)

Specifies the payee account number.

limit (Mandatory)

Specifies the max character limit.

{
    "payeeId": "10748294",
    "payeeName": "Prashant Upadhyay",
    "payeeAccountNumber": "9770570525",
    "limit": "12"
}
Response:

Parameters

Payment_BillPayList

Specifies a JSON object of Biller details in an array.

amount

Specifies the account number of the biller.

billDueAmount

Specifies the amount of bill due.

billDueDate

Specifies the date of bill due.

billGeneratedDate

Specifies the date of bill generated.

billid

Specifies the unique bill ID.

billPaidAmount

Specifies the amount of bill paid.

billPaidDate

Specifies the date on which bill is paid.

eBillEnable

Specifies the whether eBillEnabled or not. This is a Boolean value.

eBillSupport

Specifies whether ebill is supported.

ebillURL

Specifies the unique ebill URL.

fromAccountName

Specifies the name of the account from the bill is paid.

fromAccountNumber

Specifies the account number from which bill is paid.

payeeAccountNumber

Specifies the payee account number.

payeeId

Specifies the unique payee ID.

payeeName

Specifies the name of the payee.

payeeNickName

Specifies the nick name of the payee.

scheduledDate

Specifies the date for the schedule transfer.

statusDescription

Specifies whether the status of the transaction is success or failure.

transactionsNotes

Specifies the transaction notes.

transactionCurrency

Specifies the currency in which transaction is made.

{
    "Payment_BillPayList": [{
        "amount": "86.0",
        "billDueAmount": "500.0",
        "billDueDate": "2022-08-21",
        "billGeneratedDate": "2016-08-18",
        "billid": "4",
        "billPaidAmount": "72182.12",
        "billPaidDate": "2021-09-01",
        "eBillEnable": "",
        "eBillSupport": "true",
        "ebillURL": "https://retailbanking1.konycloud.com/dbimages/billpay_ebill.png",
        "fromAccountName": "Current Account",
        "fromAccountNumber": "131644",
        "payeeAccountNumber": "9770570525",
        "payeeId": "10748294",
        "payeeName": "Prashant Upadhyay",
        "payeeNickName": "Temenos",
        "scheduledDate": "2021-09-01",
        "statusDescription": "Successful",
        "transactionsNotes": "",
        "transactionCurrency": "EUR"
    }, {
        "amount": "86.0",
        "billDueAmount": "500.0",
        "billDueDate": "2022-08-21",
        "billGeneratedDate": "2016-08-18",
        "billid": "4",
        "billPaidAmount": "72182.12",
        "billPaidDate": "2021-09-01",
        "eBillEnable": "",
        "eBillSupport": "true",
        "ebillURL": "https://retailbanking1.konycloud.com/dbimages/billpay_ebill.png",
        "fromAccountName": "Current Account",
        "fromAccountNumber": "131644",
        "payeeAccountNumber": "9770570525",
        "payeeId": "10748294",
        "payeeName": "Prashant Upadhyay",
        "payeeNickName": "Temenos",
        "scheduledDate": "2021-08-31",
        "statusDescription": "Successful",
        "transactionsNotes": "",
        "transactionCurrency": "EUR"
    }],
    "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/getPayeeBills

Field Mapping

UI field Experience API field MS  API field Transact API field

amount

amount

NA

NA

billDueAmount

billDueAmount

NA

NA

billDueDate

billDueDate

NA

NA

billGeneratedDate

billGeneratedDate

NA

NA

billid

billid

NA

NA

billPaidAmount

billPaidAmount

NA

NA

billPaidDate

billPaidDate

NA

NA

ebillURL

ebillURL

NA

NA

fromAccountName

fromAccountName

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeAccountNumber

payeeAccountNumber

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

payeeNickName

payeeNickName

NA

NA

scheduledDate

scheduledDate

NA

NA

transactionCurrency

transactionCurrency

NA

NA
 
Description: This API helps user to create payments to existing bill pay payee or adhoc payment to bill pay payee.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Payment/createPayment
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

amount (Mandatory)

Specifies the to be paid.

fromAccountNumber (Mandatory)

Specifies the account number from which the account to be paid.

transactionsNotes

Specifies the notes for the current transaction.

scheduledDate (Mandatory)

Specifies the date for the schedule transaction.

transactionType (Mandatory)

Specifies the type of transaction.

deliverBy (Mandatory)

Specifies the time stamp of the transaction completion date.

toAccountNumber (Mandatory)

Specifies the account number to which amount to send.

zipCode (Mandatory)

Specifies the Zip Code.

billerId (Mandatory)

Specifies the unique biller ID.

{
    "amount": "50.00",
    "fromAccountNumber": "131644",
    "transactionsNotes": "",
    "scheduledDate": "2021-09-01T07:42:13.895Z",
    "transactionType": "BillPay",
    "deliverBy": "2021-09-01T07:42:13.895Z",
    "toAccountNumber": "9770570525",
    "zipCode": "432156",
    "billerId": "2"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique reference ID.

amount (Mandatory)

Specifies the amount to be paid.

fromAccountNumber (Mandatory)

Specifies the account number.

transactionsNotes

Specifies the notes for the transaction.

scheduledDate (Mandatory)

Specifies the date for the scheduled transaction.

transactionType (Mandatory)

Specifies the type of transaction.

deliverBy (Mandatory)

Specifies the time stamp of the transaction completion date.

toAccountNumber (Mandatory)

Specifies the account number to which amount to send.

zipCode (Mandatory)

Specifies the Zip Code.

billerId (Mandatory)

Specifies the unique biller ID.

serviceName (Mandatory)

Specifies the name of the service.

serviceCharge (Mandatory)

Specifies the charges for the transaction.

transactionAmount (Mandatory)

Specifies the amount.

{
    "referenceId": "20453",
    "opstatus": 0,
    "httpStatusCode": 0,
    "status": "Sent",
    "message": "Success! Your transaction has been completed",
    "amount": "50",
    "billerId": "2",
    "deliverBy": "2021-09-01T07:42:13.895Z",
    "fromAccountNumber": "131644",
    "scheduledDate": "2021-09-01T07:42:13Z",
    "toAccountNumber": "9770570525",
    "transactionsNotes": "",
    "transactionType": "BillPay",
    "zipCode": "432156",
    "serviceName": "BILL_PAY_CREATE",
    "serviceCharge": "0.0",
    "transactionAmount": "50.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/CreateBillPayTransaction

Field Mapping

UI API field Experience API field MS API field Transact API field
referenceId referenceId NA NA
amount amount NA NA
billerId billerId NA NA
deliverBy deliverBy NA NA
fromAccountNumber fromAccountNumber NA NA
scheduledDate scheduledDate NA NA
toAccountNumber toAccountNumber NA NA
transactionType transactionType NA NA
serviceName serviceName NA NA
zipCode zipCode NA NA
serviceCharge serviceCharge NA NA
transactionAmount transactionAmount NA NA
 
Description: This API helps user to create payments to multiple bill pay payee.
Method: POST
URL: {base_url}/ /services/data/v1/BillPay/operations/Payment/createPayment_bulk
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

fromAccountNumber (Mandatory)

Specifies the account number from which the account to be paid.

scheduledDate (Mandatory)

Specifies the date for the schedule transaction.

Bill_id

Specifies the unique bill ID.

payeeId (Mandatory)

Specifies the unique payee ID.

transactionCurrency (Mandatory)

Specifies the currency for the transaction.

amount (Mandatory)

Specifies the amount.

deliverBy (Mandatory)

Specifies the time stamp of the transaction completion date.

transactionsNotes

Specifies the notes for the current transaction.

payeeName (Mandatory)

Specifies the name of the payee.

toAccountNumber (Mandatory)

Specifies the account number to which amount to send.

{
    "bulkPayString": "[{\"fromAccountNumber\":\"131644\",\"scheduledDate\":\"2021-08-31T12:20:05.750Z\",\"Bill_id\":\"0\",\"payeeId\":\"10748294\",\"transactionCurrency\":\"EUR\",\"amount\":\"86.00\",\"deliverBy\":\"2021-09-04T12:20:05.750Z\",\"transactionsNotes\":\"\",\"payeeName\":\"Temenos\",\"toAccountNumber\":\"9770570525\"}]"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique reference ID.

deliverBy (Mandatory)

Specifies the time stamp of the transaction completion date.

fromAccountNumber (Mandatory)

Specifies the account number.

payeeId (Mandatory)

Specifies the unique payee ID.

payeeName (Mandatory)

Specifies the unique payee name.

scheduledDate (Mandatory)

Specifies the time stamp for the schedule transaction.

toAccountNumber (Mandatory)

Specifies the account number to which amount to send.

transactionCurrency (Mandatory)

Specifies the currency of transaction.

transactionType (Mandatory)

Specifies the type of transaction.

{
    "Transactions": [{
        "referenceId": "20440",
        "status": "Sent",
        "message": "Success! Your transaction has been completed",
        "amount": "86",
        "deliverBy": "2021-09-04T12:20:05.750Z",
        "fromAccountNumber": "131644",
        "payeeId": "10748294",
        "payeeName": "Temenos",
        "scheduledDate": "2021-08-31T12:20:05Z",
        "toAccountNumber": "9770570525",
        "transactionCurrency": "EUR",
        "transactionType": "BillPay"
    }],
    "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/CreateBulkBillPayTransactions

Field Mapping

UI API field

Experience API field

MS API field

Transact API field

referenceId

referenceId

NA

NA

amount

amount

NA

NA

deliverBy

deliverBy

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

scheduledDate

scheduledDate

NA

NA

toAccountNumber

toAccountNumber

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

transactionCurrency

transactionCurrency

NA

NA

transactionType

transactionType

NA

NA
 
Description: This API helps user to retrieve bill payments whose execution is same day as the day on which user submitted the payment.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Payment_BillPayList/getCompletedPayments
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

limit (Mandatory)

Specifies the max character limit.

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 starting index of the sorted records that are used in pagination.

{
    "offset": 0,
    "limit": 10,
    "sortBy": "transactionDate",
    "order": "desc",
    "paginationRowLimit": 10
}
Response:

Parameters

amount (Mandatory)

Specifies the amount.

billDueAmount (Mandatory)

Specifies the amount of bill due.

billDueDate (Mandatory)

Specifies the date of bill due.

billGeneratedDate (Mandatory)

Specifies the date of bill generated.

billid (Mandatory)

Specifies the unique bill ID.

eBillEnable

Specifies the whether eBillEnabled or not. This is a Boolean value.

ebillURL (Mandatory)

Specifies the unique ebill URL.

fromAccountName (Mandatory)

Specifies the name of the account from the bill is paid

payeeId (Mandatory)

Specifies the unique payee ID.

payeeName (Mandatory)

Specifies the name of the payee.

payeeNickName

Specifies the nick name of the payee.

referenceId (Mandatory)

Specifies the unique reference ID.

scheduledDate (Mandatory)

Specifies the time stamp for the schedule transaction.

transactionsNotes

Specifies the transaction notes.

isScheduled

Specifies whether transaction is scheduled or not. This is a boolean value.

transactionType (Mandatory)

Specifies the type of transaction.

numberOfRecurrences (Mandatory)

Specifies the number of recurrences.

transactionId (Mandatory)

Specifies the unique transaction ID.

frequencyType (Mandatory)

Specifies the type of transaction single or multiple.

transactionDate (Mandatory)

Specifies the time stamp of the transaction.

statusDescription (Mandatory)

Specifies whether status of transaction is successful or failure.

description

Specifies the desciption.

transactionCurrency (Mandatory)

Specifies the currency of transaction.

isBusinessPayee (Mandatory)

Specifies the whether it is business account.

serviceName (Mandatory)

Specifies the name of the service.

{
    "Payment_BillPayList": [{
        "amount": "86.00",
        "billDueAmount": "500.0",
        "billDueDate": "2022-07-21",
        "billGeneratedDate": "2016-08-18",
        "billid": "4",
        "eBillEnable": "0",
        "ebillURL": "https://retailbanking1.konycloud.com/dbimages/billpay_ebill.png",
        "fromAccountName": "Current Account",
        "fromAccountNumber": "131644",
        "payeeId": "10748294",
        "payeeName": "Prashant Upadhyay",
        "payeeNickName": "Temenos",
        "referenceId": "20440",
        "scheduledDate": "2021-08-31T12:00:00Z",
        "toAccountNumber": "9770570525",
        "transactionsNotes": "",
        "isScheduled": "false",
        "transactionType": "BillPay",
        "numberOfRecurrences": "0",
        "transactionId": "20440",
        "frequencyType": "Once",
        "transactionDate": "2021-08-31T11:20:07Z",
        "statusDescription": "Successful",
        "description": "Bill Pay To Temenos",
        "transactionCurrency": "EUR",
        "isBusinessPayee": "0",
        "serviceName": "BILL_PAY_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/getUserCompletedBillHistory

Field Mapping

UI field Experience API field MS  API field Transact API field

 amount

 amount

NA

NA

billDueAmount

billDueAmount

NA

NA

billDueDate

billDueDate

NA

NA

billGeneratedDate

billGeneratedDate

NA

NA

billid

billid

NA

NA

ebillURL

ebillURL

NA

NA

fromAccountName

fromAccountName

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeId

payeeId

NA

NA

payeeName

payeeName

NA

NA

referenceId

referenceId

NA

NA

scheduledDate

scheduledDate

NA

NA

toAccountNumber

toAccountNumber

NA

NA

transactionsNotes

transactionsNotes

NA

NA

isScheduled

isScheduled

NA

NA

transactionType

transactionType

NA

NA

numberOfRecurrences

numberOfRecurrences

NA

NA

transactionId

transactionId

NA

NA

frequencyType

frequencyType

NA

NA

transactionDate

transactionDate

NA

NA

transactionCurrency

transactionCurrency

NA

NA

isBusinessPayee

isBusinessPayee

NA

NA

serviceName

serviceName

NA

NA

description

description

NA

NA
 
Description: This API helps user to view future dated payments and recurring payments.
Method: POST
URL: {base_url}/ services/data/v1/BillPay/operations/Payment_BillPayList/getScheduledPayments
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

firstRecordNumber (Mandatory)

Specifies the first record number.

lastRecordNumber (Mandatory)

Specifies the last record number.

sortBy (Mandatory)

Specifies the type of method to sort the list like sort by Schedule date.

order (Mandatory)

Specifies whether it is a ascending or descending order.

{
    "firstRecordNumber": 1,
    "lastRecordNumber": 100,
    "sortBy": "scheduledDate",
    "order": "desc"
}
Response:

Parameters

Payment_BillPayList (Mandatory)

Specifies the list of payment bills.
{
    "Payment_BillPayList": {},
    "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/getUsersScheduledBills

Field Mapping

UI field Experience API field MS  API field Transact API field

 Payment_BillPayList

 Payment_BillPayList

NA

NA

firstRecordNumber

firstRecordNumber

NA

NA

lastRecordNumber

lastRecordNumber

NA

NA

order

order

NA

NA
 
Description: This API helps user to update onetime or amend recurring bill pay payments.
Method: POST
URL: {base_url}/services/data/v1/BillPay/operations/Payment/updatePayment
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

amount (Mandatory)

Specifies the amount.

payeeId (Mandatory)

Specifies the unique payee ID.

Bill_id (Mandatory)

Specifies the unique Bill ID

fromAccountNumber (Mandatory)

Specifies the account number.

transactionsNotes

Specifies the transaction notes.

scheduledDate (Mandatory)

Specifies the time stamp for the schedule transaction.

isBusinessPayee

Specifies whether payee is a business account.

transactionType (Mandatory)

Specifies the type of transaction.

transactionCurrency (Mandatory)

Specifies currency of transaction

frequencyStartDate (Mandatory)

Specifies the start of the frequency.

frequencyEndDate

Specifies the end date of the frequency.

frequencyType (Mandatory)

Specifies the type of transaction single or multiple.

numberOfRecurrences (Mandatory)

Specifies the total number of recurrences for the payment.

transactionId (Mandatory)

Specifies the unique transaction ID.

{
    "amount": "2.00",
    "payeeId": "10748294",
    "Bill_id": "4",
    "fromAccountNumber": "131644",
    "transactionsNotes": "",
    "scheduledDate": "2021-09-03T09:17:22.354Z",
    "isBusinessPayee": "0",
    "transactionType": "BillPay",
    "transactionCurrency": "EUR",
    "frequencyStartDate": "",
    "frequencyEndDate": "",
    "frequencyType": "Daily",
    "numberOfRecurrences": "5",
    "transactionId": "20462"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique reference ID.

amount (Mandatory)

Specifies the amount.

frequencyType (Mandatory)

Specifies the type of transaction single or multiple.

fromAccountNumber (Mandatory)

Specifies the account number.

numberOfRecurrences (Mandatory)

Specifies the total number of recurrences for the payment.

payeeId (Mandatory)

Specifies the unique payee ID.

scheduledDate (Mandatory)

Specifies the time stamp for the schedule transaction.

toAccountNumber (Mandatory)

Specifies the account number to which amount to send.

transactionCurrency (Mandatory)

Specifies the currency for transaction.

transactionsNotes

Specifies the transaction notes.

transactionType (Mandatory)

Specifies the type of transaction.

serviceCharge (Mandatory)

Specifies the service charges for the transaction.

serviceName (Mandatory)

Specifies the name of the service.

transactionAmount (Mandatory)

Specifies the amount.

{
    "referenceId": "20462",
    "opstatus": 0,
    "httpStatusCode": 0,
    "status": "Sent",
    "message": "Success! Your transaction has been completed",
    "amount": "2",
    "frequencyType": "Daily",
    "fromAccountNumber": "131644",
    "numberOfRecurrences": "5",
    "payeeId": "10748294",
    "scheduledDate": "2021-09-03T09:17:22Z",
    "toAccountNumber": "9770570525",
    "transactionCurrency": "EUR",
    "transactionsNotes": "",
    "transactionType": "BillPay",
    "serviceName": "BILL_PAY_CREATE",
    "serviceCharge": "0.0",
    "transactionAmount": "2.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

referenceId

referenceId

NA

NA

amount

amount

NA

NA

frequencyType

frequencyType

NA

NA

numberOfRecurrences

numberOfRecurrences

NA

NA

fromAccountNumber

fromAccountNumber

NA

NA

payeeId

payeeId

NA

NA

scheduledDate

scheduledDate

NA

NA

toAccountNumber

toAccountNumber

NA

NA

transactionType

transactionType

NA

NA

serviceName

serviceName

NA

NA

transactionCurrency

transactionCurrency

NA

NA

transactionCurrency

transactionCurrency

NA

NA

serviceCharge

serviceCharge

NA

NA

transactionAmount

transactionAmount

NA

NA
 
Description: This API helps to stop recurring bill pay payment.
Method: POST
URL: {base_url}/ services/data/v1/BillPay/operations/Payment/updatePayment_delete
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request:

Parameters

transactionId (Mandatory)

Specifies the unique transaction ID.

transactionType (Mandatory)

Specifies the type of transaction.

{
    "transactionId": "20462",
    "transactionType": "BillPay"
}
Response:

Parameters

referenceId (Mandatory)

Specifies the unique reference ID.

{
    "referenceId": "20462",
    "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

referenceId

referenceId

NA

NA

transactionId

amount

NA

NA

transactionType

frequencyType

NA

NA
 
Description: This API helps to view ebills with their details.
Method: POST
URL: {base_url}/services/data/v1/BillPay/objects/Payment_ebills?
Security Level: Authenticated App Users
Header Request:

X-Kony-Authorization
Body Request: 
{}
Response: 
{
    "records": [],
    "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/getBillsDueForUser

Field Mapping

UI field Experience API field MS  API field Transact API field

records

records

NA

NA
 
 
Parameter Name DataType Optional/Mandatory Description

limit

 string

 Mandatory

limit

sortBy

 string

 Mandatory

sort by

order

string

Mandatory

order

paginationRowLimit

string

Mandatory

page row limit

fromAccountNumber

 string

 Mandatory

from account number

scheduledDate

string

Mandatory

scheduled date

payeeId

string

Mandatory

payee id number

transactionCurrency

string

Mandatory

transaction currency

amount

string

Mandatory

amount

payeeName

string

Mandatory

payee name

toAccountNumber

string

Mandatory

to account number

referenceId

string

Mandatory

reference id

transactionType

string

Mandatory

transaction type

billDueAmount

 string

 Mandatory

bill due amount

billDueDate

string

Mandatory

bill due date

billGeneratedDate

string

Mandatory

bill generated date

billid

string

Mandatory

bill id

eBillEnable

string

Mandatory

eBill Enable

ebillURL

string

Mandatory

eBill URL

fromAccountName

string

Mandatory

from account name

payeeNickName

string

Mandatory

payee nick name

transactionsNotes

string

Mandatory

transaction notes

isScheduled

 string

 Mandatory

is scheduled

numberOfRecurrences

string

Mandatory

number of recurrences

transactionId

string

Mandatory

transaction id

frequencyType

string

Mandatory

frequency type

transactionDate

string

Mandatory

transaction date

statusDescription

string

Mandatory

status description

description

string

Mandatory

description

isBusinessPayee

string

Mandatory

is bussiness payee

serviceName

string

Mandatory

service name

firstRecordNumber

string

Mandatory

first record number

lastRecordNumber

string

Mandatory

last record number

Payment_BillPayList

string

Mandatory

list of payment bill pay

billPaidAmount

string

Mandatory

Bill Paid Amount

billPaidDate

string

Mandatory

Bill Paid date

eBillSupport

string

Mandatory

EBill Support

payeeAccountNumber

string

Mandatory

Payee Account number
 
Parameter Name DataType Optional/Mandatory Description

records

 string

 Mandatory

 Records
 
Parameter Name DataType Optional/Mandatory Description

sortBy

 string

 Mandatory

sort by

order

string

Mandatory

order

paginationRowLimit

string

Mandatory

page row limit

sortByType

 string

 Mandatory

sort by type

accountNumber

string

Mandatory

Account number

addressLine1

string

Mandatory

address

addressLine2

 string

 Mandatory

address

billerId

string

Mandatory

Biller id

billermaster_id

string

Mandatory

Biller master id

billid

 string

 Mandatory

Bill id

coreCustomerId

string

Mandatory

Core customer id

contractId

string

Mandatory

contract id

cityName

 string

 Mandatory

City name

companyName

string

Mandatory

Company name

country

string

Mandatory

Country

eBillStatus

 string

 Mandatory

EBill Status

eBillSupport

string

Mandatory

EBill support

payeeId

string

Mandatory

Payee id

isAutoPayEnabled

 string

 Mandatory

Is Auto Pay enabled

isManuallyAdded

string

Mandatory

Is manually added

isWiredRecepient

string

Mandatory

is wired recipient

lastPaidAmount

 string

 Mandatory

Last Paid Amount

lastPaidDate

string

Mandatory

Last Paid date

payeeName

string

Mandatory

Payee name

nameOnBill

 string

 Mandatory

Name on Bill

payeeNickName

string

Mandatory

Payee nick name

notes

string

Mandatory

notes

phone

 string

 Mandatory

phone

state

string

Mandatory

state

transitDays

string

Mandatory

Transit days

userId

string

Mandatory

User ID

zipCode

 string

 Mandatory

Zip code

payeeAccountNumber

string

Mandatory

Payee Account Number

noOfCustomersLinked

string

Mandatory

Number of customers linked

isBusinessPayee

string

Mandatory

Is Business Payee

street

string

Mandatory

Street name

EBillEnable

string

Mandatory

Enable Ebill

searchString

string

Mandatory

Search string
 
Parameter Name DataType Optional/Mandatory Description

searchString

string

Mandatory

Search the string

limit

string

Mandatory

Limit

accountNumber

string

Mandatory

Account number

address

string

Mandatory

address

billerCategoryId

string

Mandatory

Biller category ID

billerCategoryName

string

Mandatory

Biller Category name

billerName

string

Mandatory

Biller name

city

string

Mandatory

City

ebillSupport

string

Mandatory

Ebill Support

id

string

Mandatory

ID

state

string

Mandatory

state

zipCode

string

Mandatory

Zip code

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 4:58:43 PM IST