Temenos Digital
Updated On 09 December 2022 | Min(s) read

Cheque Management

Name Description Introduced In
createRequest This API allows the user to create a request to stop the cheque payment. 2020.07
getRequest This API allows the user to fetch the requests made to stop the cheque payments. 2020.07
createRequest This API allows the user to create a request for generating a cheque book. 2020.07
getRequest This API allows the user to fetch the requests made to generate the cheque books. 2020.07
getDetails This API allows the user to view all the cheques along with their status issued by the customer for an account. 2021.07
createRequest This API allows the user to revoke the stop payment of a cheque. 2021.07
getChequeTypes This API is used to fetch the list of cheque book types. 2021.07
createOrder This API creates authorized cheque book request. 2021.10
 
Description: This API allows the user to create a request to stop the cheque payment.
Method: POST
URL: {base_url}/services/data/v1/ChequeManagement/operations/StopPayment/createRequest
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "fromAccountNumber": "123118",
    "payeeName": "test9",
    "checkNumber1": "0",
    "checkDateOfIssue": "20211110",
    "checkReason": "3",
    "transactionsNotes": "test8",
    "validate": "false",
    "transactionType": "StopCheckPaymentRequest",
    "amount": "14.00",
    "requestValidityInMonths": "6"
}
Response: 
{
    "referenceId": "SPC2131559B4Y",
    "dataStatus": "Failed",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Transact
Enterprise API:

{base_url}//v1.0.0/order/paymentStops/$fromAccountNumber

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
From fromAccountNumber requestIn.fromAccountNumber accountId
Payee payeeName requestIn.payeeName beneficiaryId
First Cheque number checkNumber1 requestIn.checkNumber1 firstChequeId
Last Cheque number checkNumber2 requestIn.checkNumber2 lastChequeId
Date of Issue checkDateOfIssue requestIn.checkDateOfIssue stopDate
Amount amount requestIn.amount amountFrom
Reason checkReason requestIn.checkReason stopTypeId
Notes transactionsNotes requestIn.transactionsNotes remarks
Fee NA NA NA
Reference number referenceId id id
 
Description: This API allows the user to fetch the requests made to stop the cheque payments.
Method: GET
URL: {base_url}/services/data/v1/ChequeManagement/objects/StopPayment/getRequest
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "offset": 0,
    "limit": "5",
    "sortBy": "transactionDate",
    "order": "desc",
    "paginationRowLimit": 10,
    "transactionType": "StopCheckPaymentRequest",
    "accountID": "123118"
}
Response: 
{
    "StopPayment": [{
            "amount": "10.00",
            "fromAccountNumber": "123118",
            "fromNickName": "Current Account",
            "payeeName": "test1",
            "statusDescription": "SUCCESS",
            "transactionDate": "2021-11-09",
            "transactionId": "SPC21313EHQHS",
            "checkNumber1": "0",
            "checkDateOfIssue": "20210108",
            "checkReason": "Cheque Stolen",
            "requestType": "single",
            "fees": "50.0",
            "transactionsNotes": "test1"
        },

    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Transact
Enterprise API:

{base_url}//v1.0.0/order/paymentStops/$fromAccountNumber

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
NA offset NA offset
NA limit NA limit
NA sortBy NA sortBy
NA order NA order
Pagination Row Limit paginationRowLimit NA paginationRowLimit
Transaction Type transactionType NA transactionType
Account Id accountID NA accountID
 
Description: This API allows the user to create a request for generating a cheque book.
Method: POST
URL: {base_url}/services/data/v1/ChequeManagement/objects/ChequeBook/createRequest
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request:

Parameters

chequeIssueId

Specifies the unique chequeIssueId.

note

Specifies the notes for the request.

validate

Specifies whether the request to be validated or not. This is a boolean value.

accountID

Specifies the unique accountID.

{
    "chequeIssueId": "SB.123118.0000015",
    "note": "New",
    "validate": "false",
    "accountID": "123118"
}
Response:

Parameters

chequeIssueId

Specifies the unique chequeIssueId.

fees

Specifies the fees for the request.

{
    "chequeIssueId": "OCB21315WMP1E",
    "status": "Request Initiated",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider: Transact
Enterprise API:

{base_url}/v1.0.0/holdings/chequeIssues/{recordId}

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Account chequeIssueId  requestIn.chequeIssueId chequeIssueId
 Leaves NA NA NA
No. of Cheque books NA NA NA
Address NA NA NA
Notes note requestIn.note note
Fee NA NA NA
Request Number chequeIssueId id id
 
Description: This API allows the user to fetch the requests made to generate the cheque books.
Method: POST
URL: {base_url}/services/data/v1/ChequeManagement/objects/ChequeBook/getRequest
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "offset": 0,
    "limit": "10",
    "sortBy": "transactionDate",
    "order": "desc",
    "paginationRowLimit": 10,
    "transactionType": "StopCheckPaymentRequest",
    "accountID": "123118"
}
Response: 
{
    "ChequeBookRequests": [{
            "accountID": "123118",
            "chequeStatus": "Request Initiated",
            "chequeIssueId": "OCB21314947F5",
            "issueDate": "20211110",
            "fees": "1.50",
            "note": "test",
            "numberOfLeaves": "10",
            "numberOfChequeBooks": "2",
            "address": "3"
        }

    ],
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider:  
Enterprise API:

{base_url}/v1.0.0/holdings/chequeIssues

Field Mapping

UI field Experience API field MS API field Transact API Field
NA  chequeNumberStart NA  chequeNumberStart
NA  description NA  description
NA chequeStatus NA chequeStatus
NA chequeIssueId NA chequeIssueId
NA issueDate NA issueDate
NA numberIssued NA numberIssued
NA fees NA fees
NA note NA note
NA numberOfLeaves NA numberOfLeaves
NA numberOfChequeBooks NA numberOfChequeBooks
NA deliveryType NA deliveryType
NA address NA address
NA requestId NA requestId
 
Description: This API allows user to view all the cheques issued by the customer for an account with their status.
Method: GET
URL: {base_url}/services/data/v1/ChequeManagement/operations/ChequeDetails/getDetails
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "accountID": "123118"
}
Response: 
{
    "ChequeSupplements": [{
        "issueDate": "2021-11-10",
        "payeeNames": [{
            "payeeName": "TEST123"
        }],
        "chequeStatus": "Cleared",
        "checkNumber": "1",
        "chequeTypeId": "CURR",
        "amount": "100.0"
    }, {
        "issueDate": "2021-11-10",
        "payeeNames": [],
        "chequeStatus": "Stopped",
        "checkNumber": "12",
        "chequeTypeId": "SB",
        "amount": "0.0"
    }],
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s):

 
Enterprise Provider: Transact
Enterprise API:

{base_url}/v1.0.0/holdings/cheques

Field Mapping

UI Field Experience API Field MS API Field Transact API Field
Cheque number checkNumber NA chequeNumber
Status chequeStatus NA chequeNumber
Payee Name payeeNames NA beneficiaries.beneficiaryId
Date issueDate NA date
Amount amount NA chequeAmount
Reference number referenceNumber NA referenceNumber
Reasons NA NA NA
Notes NA NA NA
 
Description: This API allows the user to create a request to stop the cheque payment.
Method: POST
URL: {base_url}/services/data/v1/ChequeManagement/operations/RevokeStopPayment/createRequest
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "fromAccountNumber": "123118",
    "payeeName": "test9",
    "checkNumber1": "1234",
    "revokeDate": "20211110",
    "revokeChequeTypeId": "1",
    "isRevoke": "false",
    "amount": "14.00"
}
Response: 
{
    "referenceId": "RSP213151F7XY",
    "dataStatus": "Failed",
    "opstatus": 0,
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider:  
Enterprise API:

 

Field Mapping

UI field Experience API field MS API field Transact API Field
fromAccountNumber fromAccountNumber NA fromAccountNumber
payeeName payeeName NA payeeName
checkNumber checkNumber NA checkNumber
revokeChequeTypeId revokeChequeTypeId NA revokeChequeTypeId
revokeDate revokeDate NA revokeDate
amount amount NA amount
 
Description: This API is used to fetch the list of cheque book types.
Method: POST
URL: {base_url}/services/data/v1/ChequeManagement/operations/ChequeBook/getChequeTypes
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request: 
{
    "category": "1007”
}
Response: 
{
    "ChequeTypes": [{
        "description": "Current Accounts",
        "chequeId": "CURR",
        "defaultIssueNumber": "50"
    }],
    "opstatus": 0,
    "httpStatusCode": 200
}
Error Code(s):

 
Enterprise Provider: Transact
Enterprise API:

{base_url}/v1.0.0/reference/chequeTypes?category={categoryId}

Transact Artifact ST.API.CHEQUE.TYPES.1.0.0

Field Mapping

UI Field

 Experience API Field MS API Field Transact API field

ChequeTypes

ChequeTypes

NA

ChequeTypes

description

description

NA

description

chequeId

chequeId

NA

chequeId

defaultIssueNumber

defaultIssueNumber

NA

defaultIssueNumber
 
Description: This API creates authorized cheque book request.
Method: POST
URL: {base_url}/services/ServiceRequestJavaService/createOrder
Security Level: Authenticated App User
Header Request:

X-Kony-Authorization

Body Request:

Parameters

accountId

Specifies the unique accountId.

type

Specifies the type of request.

chequeIssueId

Specifies whether the request to be validated or not. This is a boolean value.

note

Specifies the type of request.

deliveryType

Specifies the type of delivery.

numberOfLeaves

Specifies the total number of leaves in the cheque book.

numberOfChequeBooks

Specifies the total number of cheque books in the current request.

{
    "accountId": "127094",
    "type": "Cheque",
    "requestBody": "{'chequeIssueId':'SB.127094.00007','note':'test','deliveryType':'','address':'3','fees':'1.50','accountId':'127094','numberOfLeaves':'10','numberOfChequeBooks':'2'}",
    "subtype": "OrderChequeBook",
    "signatoryApprovalRequired": "false"
}
Response:

Parameters

orderId

Specifies the unique orderId.

message

Specifies the transaction message(Success or Failure message).

status

Specifies the status of the request.

{
    "code": "",
    "orderId": "OCB212992OFQ1",
    "opstatus": 0,
    "message": "Service Request created successfully",
    "status": "Request Initiated",
    "httpStatusCode": 0
}
Error Code(s):

 
Enterprise Provider:  
Enterprise API:

 

In this topic

Copyright © 2020- Temenos Headquarters SA

Contact Us

knowledge@temenos.com

Published on :
Sunday, March 23, 2025 4:03:49 PM IST