Request Method :: POST

Description: This API is used to map a device to a user through VPA ID, device serial number and device type.

Endpoint URL: /soundbox_trigger

Request Body Parameters

Parameters	Parameter description (with examples)	Data type	Mandatory/Optional
customer_name	Customer Name. E.g. -abc	String	Optional
txn_currency	Transaction Currency E.g. - rupee	string	Optional
txn_amount	Transaction Amount E.g. - 19	string	Optional
ref_n	Reference Number. E.g-12345	string	Optional
status	Status. E.g. - Success	string	Optional
time_stamp	Timestamp	string	Optional
customer_vpa	Customer VPA	string	Optional
merchant_vpa	Merchant VPA. E.g. - iserveu29	string	Mandatory
tr_id	TR ID E.g. - 431800158577	string	Optional
merchant_id	Merchant ID	string	Optional
serial_number	Serial Number. E.g. - 6966333	string	Optional
checksum	Checksum	string	Optional
bank_code	Bank Code. E.g. - slice	string	Optional
txn_type	Transaction Type. E.g. - UPI	string	Optional

Sample Request Body

---

{ "customer_name": "abc", "txn_currency": "rupee", "txn_amount": "19", "ref_no": "12345", "status": "S", "time_stamp": "2024-11-13 12:12:45 PM", "customer_vpa": " ", "merchant_vpa": "iserveu29", "tr_id": "431800158577", "merchant_id": "", "serial_number": "6966333", "checksum": "", "bank_code": "slice", "txn_type": "UPI" }

Response Body Parameters

Parameters	Parameter description(with examples)	Data type
status	Status. E.g. - 0	Integer
message	Message.E.g. - Message successfully sent	string
errors	Errors (Only in case of Failed Responses)	string
type	Error Type.E.g- field	string
msg	Error related message. E.g. - merchent_vpa is mandatory.	string
path	Path. E.g- merchant_vpa	String
location	Location. E.g. - body	String

Sample Response Body

---

SUCCESS:

{ "status": 0, "message": "Message successfully sent" }

 

FAILED:

If merchant_vpa is missing:

{ "status": 1, "message": "merchant_vpa is mandatory", "errors": [ { "type": "field", "msg": "merchant_vpa is mandatory", "path": "merchant_vpa", "location": "body" } ] }

In case of invalid merchant_vpa or merchant_vpa not mapped with the device:

{ "status": 1, "message": "ERR001 VPA Not found in database" }

In case the device is not active.:

{ "status": 1, "message": "ERR002 Device is inactive" }

Invalid Base Url:

{ "status": 0, "message": "ERR0008 The url you are trying to reach is not hosted on our server" }

Error Codes

Error Codes	Error Codes Description
ERR0001	If merchant_vpa is not found in the database.
ERR0002	Device is not active
ERR0008	Invalid Base url