Trigger Soundbox API:

Request Method :: POST

Description: This API retrieves a payload from a bank server, validates it based on the bank name, and decrypts it if necessary. For plaintext payloads, it proceeds directly. It fetches mapping data (if applicable) or skips this step for banks without a database. The API publishes a message, triggers the soundbox to announce the transaction amount, and attempts to store the transaction in the history table. If storage fails, it pushes the data to Pub/Sub, except for banks without a database.

Staging Base URL: https://apidev-sdk.iserveu.online/common/isu_soundbox/txn/trigger

Headers

---

Content-Type: application/JSON

header_secrets:  To be shared during integration by ISU Team

pass_key:  To be shared during integration by ISU Team

Columns with values:

{ column1: "tr_id", column2: "mid", column3: "tid", column4: "user_name", column5: "time_stamp", column6: "payer_mob_num", column7: "language", column8: "txnAmt", column11: "operation_performed", column12: "txn_type", column13: "transaction_status_code", column14: "status_description", column15: "status", column16: "created_date", column17: "updated_date", column18: "rrn", column20: "ref_no", column23: "payer_mid", column29: "payee_mid", column34: "is_mapped", column35: "txn_currency", column36: "payer_name", column37: "bankcode", column38: "checksum", column39: "Features", column40: "statuscode" };

Request Body Parameters

Field Name	Description	Data type	Mandatory/Optional/ Conditional
column1	Transaction id E.g. - 7656789878ee	VARCHAR	Mandatory
column3	tid(device serial no.) E.g. - 123456787654	VARCHAR	Optional
column7	language E.g. - ENGLISH	VARCHAR	Optional
column8	Transaction amount, you have to give in format like rupees.paisa(19.00) E.g. - 19.00	VARCHAR	Mandatory
column12	Transaction type E.g. - UPI,mATM,POS	VARCHAR	Optional
column15	status E.g. - success||failed	VARCHAR	Mandatory
column2	mid E.g. - test@isu	VARCHAR	Mandatory

Sample Request Body

---

{ "column2":"11@isu", "column8":"12.00", "column1":"54323456787654", "Column15":"success", "column12":"upi" }

Response Body Parameters

Parameters	Description	Data type
status	Status category (0/1). success = 0, failed = 1	VARCHAR
message	Response message (success/fail)	VARCHAR
statusDesc	Status Description	VARCHAR
data	Fetched Data	VARCHAR

Sample Response Body

---

SUCCESS:

{ "status": 0, "message": "success", "statusDesc": "Message successfully sent", "data": {} }

 

Failed cases:

If merchant_vpa is missing:

{ "status": 1, "message": "failed", "statusDesc": "payee_vpa is mandatory", "data": {} }

In case the device is not active:

{ "status": 1, "message": "failed", "statusDesc": "ERROR0007 Device is inactive", "data": {} }

Error in the case of publishing a message:

{ "status": 1, "message": "failed", "statusDesc": "ERR0004 Error in publish", "data": {} }

Error getting YPP external server error:

{ "status": 1, "message": "ERR0006 Error getting from YPP API" }

Invalid Device type:

{ "status": 1, "message": "failed", "statusDesc": "ERR0007 Invalid device type", "data": {} }

Response Status Codes

Status Code	Status	Description	HTTP Status Code
0	SUCCESS	Message successfully sent	200
1	FAILED	payee_vpa is mandatory ERROR0007 Device is inactive ERR0004 Error in publish ERR0006 Error getting from YPP API ERR0007 Invalid device type	400

Error Codes and Description:

Error Codes	Error Description
ERR0001	If merchant_vpa is not found in the database.
ERR0002	Device is not active
ERR0003	Database Error
ERR0004	Error while publishing
ERR0005	Unhandled server error
ERR0006	YPP server error
ERR0007	Invalid device type
ERR0008	Invalid Base url