obcdda-pp-chequebook-services 9.5.0

The Retail Account CheckBook/ChequeBook Service API allows publishing and subscribing to Kafka messages.

Operations

Pub ChequeBookAuthorizeEvent

event that publishes the CheckBook/ChequeBook authorization.

event that publishes the CheckBook/ChequeBook authorization.

Accepts the following message:

ChequeBookAuthorizeEvent ChequeBookAuthorizeEvent

ChequeBookAuthorizeEvent

Payload ChequeBookAuthorizeEvent
object
id
string
action
string

action

autoAuth
string

autoAuth

modificationStatus
string

modificationStatus

datasegmentCode
string

datasegmentCode

checkerRemarks
string

checker remarks

makerRemarks
string

maker remarks

branchCode
string
>= 3 <= 3

Branch code of the customer account branch

accountNumber
string
<= 50

Customer account number for which the check book order is placed

chequeLeaves
string
firstChequeNo
string
<= 16

First check number of the check book order. Eg: If first check number is 000001 and the number of check leaves is 15, then the check numbers in the check book issued will be 000001, 000002...000015

chequeBookType
string

Specifies the type of check book for which the order is placed

orderDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date on which the check book order request is placed for the account

orderDetails
string
<= 105

Additional order details of the check book order can be captured here.

languageCode
string
<= 10

The printing language for the check book order processing. Eg: For english the code can be captured as ENG

issueDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date on which the check book order was processed and check book is issued.

printStatus
string
>= 1 <= 1

The printing status for the check book order

includeChqbookPrinting
string
>= 1 <= 1

Tag to signify if the check book order process to include check book printing. This tag will accept (Y - Yes and N - No)

Enum: "Y" "N"
deliveryReferenceNo
string
<= 10

Refers to the delivery reference number generated for the check book order.

deliveryMode
string
<= 10

Signifies the check book delivery mode for the order as preferred by the customer. Check book can be delivered to preferred branch or customer preferred address (B - Branch and C - customer preferred address and if address type is custom then user needs to provide data in ISO format otherwise it will be fetched from account-service)

deliveryDate
string
must match ^\d{4}-\d{2}-\d{2}$

Date on which the check book was delivered to the customer address or branch as per the preferred delivery mode

chequeBookDelivered
string
>= 1 <= 1

Flag to indicate if the check book is delivered or yet to be delivered. Can accept values (Y - Yes and N- No)

Enum: "Y" "N"
addressCode
string
<= 12

The address code of the check book delivery address of the customer

requestMode
string
<= 30

The mode of placing the check book order request

requestStatus
string
<= 30

The current status of the check book order request

applyCharge
string
>= 1 <= 1

Specifies if a charge is to be applied on the customer account for check book order processing. This tag can take values (Y - Yes and N - No)

Enum: "Y" "N"
issuingBranch
string
>= 3 <= 3

The branch code of the check book issuing branch

addrLine1
string
<= 150

Check book delivery address line1

addrLine2
string
<= 150

Check book delivery address line2

addrLine3
string
<= 150

Check book delivery address line3

addressType
string
mediaAddress
string
<= 120

Check book delivery media address

languageName
string
>= 3 <= 3

The language in which the check book will be printed

department
string
<= 70

Check book delivery address department

subDepartment
string
<= 70

Check book delivery address sub department

streetName
string
<= 70

Check book delivery address street name

buildingNumber
string
<= 16

Check book delivery address building number

buildingName
string
<= 35

Check book delivery address building name

floor
string
<= 70

Check book delivery address floor

room
string
<= 70

Check book delivery address room

postcode
string
<= 16

Check book delivery address postcode

townName
string
<= 35

Check book delivery address town name

townLocationName
string
<= 35

Check book delivery address town location name

districtName
string
<= 35

Check book delivery address district name

countrySubDivision
string
<= 35

Check book delivery address country subdivision

strrCountry
string
<= 2

Check book delivery address Country code. Eg: IN, US etc.

accDomain
string
deliveryBranch
string
>= 3 <= 3

The check book delivery branch code, if the delivery mode is Branch.

deliveryBranchName
string
<= 150

The check book delivery branch name, if the delivery mode is Branch.

currency
string
reorderError
string
displayName
string
<= 150

If external check book option is enabled at bank level then preferred name to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

displayAddress
string
<= 350

If external check book option is enabled at bank level then preferred address to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

displayPhoneNumber
string
<= 20

If external check book option is enabled at bank level then preferred phone number to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

externalChqBk
string
>= 1 <= 1

This flag denotes if the Bank has opted for external check book order processing and printing using a 3rd party service provider. The applicable values are Y - Yes and N - No

Enum: "Y" "N"
chequeBookDetailsStreams chequeBookDetailsStreams
array<object>
id
string

id

chequeDetailsId
string
<= 36

Check details ID generated by the system

branchCode
string
>= 3 <= 3

The Branch Code of the customer account from which the check was issued

accountNumber
string
<= 20

The customer account number for which the check was issued

chequeBookNumber
string
<= 16

The check book number from which the check leaf was issued.

chequeNumber
string
<= 16

The issued check leaf number

status
string
<= 1

This tag signifies the status of the check leaf such as used, unused etc.

amount
string

The amount of the issued check leaf number

beneficiary
string
<= 105

The beneficiary details of the issued check

presentationDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date of presenting the check leaf for clearing

valueDate
string
must match ^\d{4}-\d{2}-\d{2}$

The value date of the issued check leaf

checkDigit
string
<= 1

System generated checkdigit

rejectCode
string
<= 2

Check leaf rejection code incase of check rejection by the payment system

updateMode
string
<= 1

This tag captures the update mode

claimAmount
string

This tag signifies the claim amount

Additional items are allowed.

Additional properties are allowed.

Examples

ChequeBookAuthorizeEvent
Payload
{ "id": "string", "action": "string", "autoAuth": "string", "modificationStatus": "string", "datasegmentCode": "string", "checkerRemarks": "string", "makerRemarks": "string", "branchCode": "string", "accountNumber": "string", "chequeLeaves": "string", "firstChequeNo": "string", "chequeBookType": "string", "orderDate": "2023-06-14", "orderDetails": "string", "languageCode": "string", "issueDate": "2023-06-14", "printStatus": "string", "includeChqbookPrinting": "Y", "deliveryReferenceNo": "string", "deliveryMode": "string", "deliveryDate": "2023-06-14", "chequeBookDelivered": "Y", "addressCode": "string", "requestMode": "string", "requestStatus": "string", "applyCharge": "Y", "issuingBranch": "string", "addrLine1": "string", "addrLine2": "string", "addrLine3": "string", "addressType": "string", "mediaAddress": "string", "languageName": "string", "department": "string", "subDepartment": "string", "streetName": "string", "buildingNumber": "string", "buildingName": "string", "floor": "string", "room": "string", "postcode": "string", "townName": "string", "townLocationName": "string", "districtName": "string", "countrySubDivision": "string", "strrCountry": "string", "accDomain": "string", "deliveryBranch": "string", "deliveryBranchName": "string", "currency": "string", "reorderError": "string", "displayName": "string", "displayAddress": "string", "displayPhoneNumber": "string", "externalChqBk": "Y", "chequeBookDetailsStreams": [ { "id": "string", "chequeDetailsId": "string", "branchCode": "string", "accountNumber": "string", "chequeBookNumber": "string", "chequeNumber": "string", "status": "string", "amount": "string", "beneficiary": "string", "presentationDate": "2023-06-14", "valueDate": "2023-06-14", "checkDigit": "string", "rejectCode": "string", "updateMode": "string", "claimAmount": "string" } ] }
This example has been generated automatically.

Pub StopPaymentsAuthorizeEvent

event to publish the stop payments authorization.

event to publish the stop payments authorization.

Accepts the following message:

StopPaymentsAuthorizeEvent StopPaymentsAuthorizeEvent

StopPaymentsAuthorizeEvent

Payload StopPaymentsAuthorizeEvent
object
id
string
action
string
autoAuth
string

autoAuth

modificationStatus
string

modificationStatus

datasegmentCode
string

datasegmentCode

checkerRemarks
string

checkerRemarks

makerRemarks
string

makerRemarks

branchCode
string
>= 3 <= 3

Branch code of the customer account branch

accountNumber
string
<= 50

Customer account number for which the check book order is placed

accountDomain
string

Captures the account domain for the stop payment request

stopPaymentType
string
<= 36

Signifies the stop payment type

startChequeNo
string
<= 16

This tag captures the start check number for a stop payment request. If only start check number is captured then stop payment is processed only for that check number. If stop payment is required for a range of checks then both start and end check numbers are to be captured.

endChequeNo
string
<= 16

This tag captures the end check number for a stop payment request. This is applicable only if the stop payment request is to be processed for a range of checks.

currency
string

the currency of the issued check for which the stop payment request is to be processed

amount
string

The amount of the issued check for which the stop payment request is to be processed

confirmed
string
<= 1

This tag confirms the stop payment processing. The applicable values are Y - Yes and N - No

Enum: "Y" "N"
effectiveDate
string
must match ^\d{4}-\d{2}-\d{2}$

The effective date of the stop payment request. The stop payment of the check will be effective as on this date.

expiryDate
string
must match ^\d{4}-\d{2}-\d{2}$

The expiry date of the stop payment request. The stop payment will be revoked on this date

externalReferenceNumber
string
<= 36

System generated external reference number

source
string
<= 16

Source application of the stop payment request

remarks
string
<= 255

Capture remarks for stop payment

stopPaymentNumber
string
<= 36

Generated stop payment request number

stopPaymentDetailsStreams stopPaymentDetailsStreams
array<object>
id
string
stopPaymentId
string
branchCode
string
accountNumber
string
startChequeNo
string
stopPaymentNumber
string

Additional items are allowed.

Additional properties are allowed.

Examples

StopPaymentsAuthorizeEvent
Payload
{ "id": "string", "action": "string", "autoAuth": "string", "modificationStatus": "string", "datasegmentCode": "string", "checkerRemarks": "string", "makerRemarks": "string", "branchCode": "string", "accountNumber": "string", "accountDomain": "string", "stopPaymentType": "string", "startChequeNo": "string", "endChequeNo": "string", "currency": "string", "amount": "string", "confirmed": "Y", "effectiveDate": "2023-06-14", "expiryDate": "2023-06-14", "externalReferenceNumber": "string", "source": "string", "remarks": "string", "stopPaymentNumber": "string", "stopPaymentDetailsStreams": [ { "id": "string", "stopPaymentId": "string", "branchCode": "string", "accountNumber": "string", "startChequeNo": "string", "stopPaymentNumber": "string" } ] }
This example has been generated automatically.

Messages

#1 ChequeBookAuthorizeEvent ChequeBookAuthorizeEvent

ChequeBookAuthorizeEvent

Payload ChequeBookAuthorizeEvent
object
id
string
action
string

action

autoAuth
string

autoAuth

modificationStatus
string

modificationStatus

datasegmentCode
string

datasegmentCode

checkerRemarks
string

checker remarks

makerRemarks
string

maker remarks

branchCode
string
>= 3 <= 3

Branch code of the customer account branch

accountNumber
string
<= 50

Customer account number for which the check book order is placed

chequeLeaves
string
firstChequeNo
string
<= 16

First check number of the check book order. Eg: If first check number is 000001 and the number of check leaves is 15, then the check numbers in the check book issued will be 000001, 000002...000015

chequeBookType
string

Specifies the type of check book for which the order is placed

orderDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date on which the check book order request is placed for the account

orderDetails
string
<= 105

Additional order details of the check book order can be captured here.

languageCode
string
<= 10

The printing language for the check book order processing. Eg: For english the code can be captured as ENG

issueDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date on which the check book order was processed and check book is issued.

printStatus
string
>= 1 <= 1

The printing status for the check book order

includeChqbookPrinting
string
>= 1 <= 1

Tag to signify if the check book order process to include check book printing. This tag will accept (Y - Yes and N - No)

Enum: "Y" "N"
deliveryReferenceNo
string
<= 10

Refers to the delivery reference number generated for the check book order.

deliveryMode
string
<= 10

Signifies the check book delivery mode for the order as preferred by the customer. Check book can be delivered to preferred branch or customer preferred address (B - Branch and C - customer preferred address and if address type is custom then user needs to provide data in ISO format otherwise it will be fetched from account-service)

deliveryDate
string
must match ^\d{4}-\d{2}-\d{2}$

Date on which the check book was delivered to the customer address or branch as per the preferred delivery mode

chequeBookDelivered
string
>= 1 <= 1

Flag to indicate if the check book is delivered or yet to be delivered. Can accept values (Y - Yes and N- No)

Enum: "Y" "N"
addressCode
string
<= 12

The address code of the check book delivery address of the customer

requestMode
string
<= 30

The mode of placing the check book order request

requestStatus
string
<= 30

The current status of the check book order request

applyCharge
string
>= 1 <= 1

Specifies if a charge is to be applied on the customer account for check book order processing. This tag can take values (Y - Yes and N - No)

Enum: "Y" "N"
issuingBranch
string
>= 3 <= 3

The branch code of the check book issuing branch

addrLine1
string
<= 150

Check book delivery address line1

addrLine2
string
<= 150

Check book delivery address line2

addrLine3
string
<= 150

Check book delivery address line3

addressType
string
mediaAddress
string
<= 120

Check book delivery media address

languageName
string
>= 3 <= 3

The language in which the check book will be printed

department
string
<= 70

Check book delivery address department

subDepartment
string
<= 70

Check book delivery address sub department

streetName
string
<= 70

Check book delivery address street name

buildingNumber
string
<= 16

Check book delivery address building number

buildingName
string
<= 35

Check book delivery address building name

floor
string
<= 70

Check book delivery address floor

room
string
<= 70

Check book delivery address room

postcode
string
<= 16

Check book delivery address postcode

townName
string
<= 35

Check book delivery address town name

townLocationName
string
<= 35

Check book delivery address town location name

districtName
string
<= 35

Check book delivery address district name

countrySubDivision
string
<= 35

Check book delivery address country subdivision

strrCountry
string
<= 2

Check book delivery address Country code. Eg: IN, US etc.

accDomain
string
deliveryBranch
string
>= 3 <= 3

The check book delivery branch code, if the delivery mode is Branch.

deliveryBranchName
string
<= 150

The check book delivery branch name, if the delivery mode is Branch.

currency
string
reorderError
string
displayName
string
<= 150

If external check book option is enabled at bank level then preferred name to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

displayAddress
string
<= 350

If external check book option is enabled at bank level then preferred address to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

displayPhoneNumber
string
<= 20

If external check book option is enabled at bank level then preferred phone number to be printed on each of the check leaf of the check book can be captured in this tag. This data will be used by the external third party service provider for processing the check book request in US markets.

externalChqBk
string
>= 1 <= 1

This flag denotes if the Bank has opted for external check book order processing and printing using a 3rd party service provider. The applicable values are Y - Yes and N - No

Enum: "Y" "N"
chequeBookDetailsStreams chequeBookDetailsStreams
array<object>
id
string

id

chequeDetailsId
string
<= 36

Check details ID generated by the system

branchCode
string
>= 3 <= 3

The Branch Code of the customer account from which the check was issued

accountNumber
string
<= 20

The customer account number for which the check was issued

chequeBookNumber
string
<= 16

The check book number from which the check leaf was issued.

chequeNumber
string
<= 16

The issued check leaf number

status
string
<= 1

This tag signifies the status of the check leaf such as used, unused etc.

amount
string

The amount of the issued check leaf number

beneficiary
string
<= 105

The beneficiary details of the issued check

presentationDate
string
must match ^\d{4}-\d{2}-\d{2}$

The date of presenting the check leaf for clearing

valueDate
string
must match ^\d{4}-\d{2}-\d{2}$

The value date of the issued check leaf

checkDigit
string
<= 1

System generated checkdigit

rejectCode
string
<= 2

Check leaf rejection code incase of check rejection by the payment system

updateMode
string
<= 1

This tag captures the update mode

claimAmount
string

This tag signifies the claim amount

Additional items are allowed.

Additional properties are allowed.

#2 StopPaymentsAuthorizeEvent StopPaymentsAuthorizeEvent

StopPaymentsAuthorizeEvent

Payload StopPaymentsAuthorizeEvent
object
id
string
action
string
autoAuth
string

autoAuth

modificationStatus
string

modificationStatus

datasegmentCode
string

datasegmentCode

checkerRemarks
string

checkerRemarks

makerRemarks
string

makerRemarks

branchCode
string
>= 3 <= 3

Branch code of the customer account branch

accountNumber
string
<= 50

Customer account number for which the check book order is placed

accountDomain
string

Captures the account domain for the stop payment request

stopPaymentType
string
<= 36

Signifies the stop payment type

startChequeNo
string
<= 16

This tag captures the start check number for a stop payment request. If only start check number is captured then stop payment is processed only for that check number. If stop payment is required for a range of checks then both start and end check numbers are to be captured.

endChequeNo
string
<= 16

This tag captures the end check number for a stop payment request. This is applicable only if the stop payment request is to be processed for a range of checks.

currency
string

the currency of the issued check for which the stop payment request is to be processed

amount
string

The amount of the issued check for which the stop payment request is to be processed

confirmed
string
<= 1

This tag confirms the stop payment processing. The applicable values are Y - Yes and N - No

Enum: "Y" "N"
effectiveDate
string
must match ^\d{4}-\d{2}-\d{2}$

The effective date of the stop payment request. The stop payment of the check will be effective as on this date.

expiryDate
string
must match ^\d{4}-\d{2}-\d{2}$

The expiry date of the stop payment request. The stop payment will be revoked on this date

externalReferenceNumber
string
<= 36

System generated external reference number

source
string
<= 16

Source application of the stop payment request

remarks
string
<= 255

Capture remarks for stop payment

stopPaymentNumber
string
<= 36

Generated stop payment request number

stopPaymentDetailsStreams stopPaymentDetailsStreams
array<object>
id
string
stopPaymentId
string
branchCode
string
accountNumber
string
startChequeNo
string
stopPaymentNumber
string

Additional items are allowed.

Additional properties are allowed.