• Table of contents
• Specification
• Activity Diagram
  • Programming Guide
    • Jar version
    • Jar File Download
    • properties file
  • Database Table
  • OTP Service
    • sendOTP
    • verifyPin
    • updateUsedPin
    • sendSms

Specification¶

Activity Diagram
¶

Programming Guide¶

Jar version¶

version	Description
1.11	Init
1.12	Added Allow List in development
1.13	Added Bulk SMS account

Jar File Download¶

Jar
Lib
Properties

properties file¶

• ginota.properties

1. ginota.api.key.{DB}.{country/project}
2. ginota.api.secret.{DB}.{country/project}
3. otp.validity.in.second.{DB}.{country/project}
4. local.valid.period.in.second.{DB}.{country/project}
5. url.send.otp
6. url.verify.otp
7. url.send.sms
8. connection.timeout
9. connection.read.timeout

Database Table¶

CREATE TABLE OTP_INTERFACE (
    OTP_ID VARCHAR(15) NOT NULL,
    MOBILE VARCHAR(15) NOT NULL, 
    TRX_CODE VARCHAR(5) NOT NULL,
    STATUS_CODE VARCHAR(5),
    SHOPPER_REF_NO INTEGER, 
    STATUS_DESC VARCHAR(100),
    REQUEST_ID VARCHAR(20),
    TOTAL_SMS INTEGER,    
    CREATE_DATETIME TIMESTAMP NOT NULL,
    MODIFY_DATETIME TIMESTAMP,
    ORDER_ID VARCHAR(15),
    PRIMARY KEY (OTP_ID))

OTP Service¶

com.cosway.ginota.service.OtpService service = new com.cosway.ginota.service.OtpService(); 

sendOTP¶

com.cosway.ginota.bean.ResultBean result = service.sendOTP(Connection conn, com.cosway.ginota.bean.OTPBean otpBean)

1. conn - Database connection.
2. otpBean - OTPBean object.

• shopperRefNo
• otpId - Auto setter
• transactionCode
• mobileTo
• companyName - com.cosway.ginota.constant.CommonConstant.COMPANY_NAME_*

1. result - ResultBean object.

• statusCode
• otpId
• statucDescription
• requestId
• messageId
• totalSms

verifyPin¶

com.cosway.ginota.bean.ResultBean result = service.verifyPin(Connection conn, com.cosway.ginota.bean.VerifyBean verifyBean)

1. conn - Database connection.
2. verifyBean - VerifyBean object.

• pin
• companyName - com.cosway.ginota.constant.CommonConstant.COMPANY_NAME_*
• otpId

updateUsedPin¶

com.cosway.ginota.bean.ResultBean result = service.updateUsedPin(Connection conn, com.cosway.ginota.bean.UpdateSuccessBean updateBean)

1. conn - Database connection.
2. updateBean - UpdateSuccessBean object.

• otpId
• orderId

sendSms¶

com.cosway.ginota.bean.ResultBean result = service.sendSms(Connection conn, com.cosway.ginota.bean.SmsBean smsBean)

1. conn - Database connection.
2. smsBean - SmsBean object.

• otpId - Auto setter
• transactionCode
• mobileTo
• companyName - com.cosway.ginota.constant.CommonConstant.COMPANY_NAME_*
• shopperRefNo
• mobileFrom
• content