zipdial cod api

2

Click here to load reader

Upload: amit-malhotra

Post on 16-Aug-2015

25 views

Category:

Documents


1 download

TRANSCRIPT

Page 1: Zipdial COD API

ZipDial Mobile Solutions Pvt. Ltd.,

No. 63, 3rd

floor, RMZ Gateway, 100 feet road, Koramangala, 4th

Block, Bangalore – 560034 Phone: 080 4142 1921 / 2; Email:[email protected]; Service Tax No : AAACZ4361QSD001; CIN:

U72200KA2010PTC054615

COD API DOCUMENT Sample COD API: http://www.zipdial.com/z2cod/startTransaction.action?customerToken=<<to be provided by Zipdial>> &orderRefId=<<Order Number>>&callerPhone=<<User Number>>&duration=<<Session Time>>&countryCode=91&amount=<<Amount>>&pincode=<<Pincode>> Parameter Description: A) customerToken: This is a constant configured for Customer’s account, do not change this value. B) orderRefId: This is the Order Reference ID for the customer who has placed a COD order (Mandatory) C) callerPhone: Mobile number of the customer who is placing the order (Mandatory) D) duration: Time (in seconds), this defines the duration for which the transaction is kept alive for COD verification (SMS). If not defined, the default value is 180 seconds (Not mandatory) E) countryCode: Country from which the user is verifying the COD transaction using the mobile number, for India based users its 91. F) amount: Total price of the order placed by the user on the site. G) pincode: Area pin-code of the user for verification. Sample response to the start transaction API: {"message":"ok","order_ref_id":"012345","transaction_token":"f06339de7ffa8ea507950e0738d88474b39a6c47","status":"1"} Parameter Description: A) message: A descriptive message confirming whether the COD start transaction was successful or not. B) order_ref_id: This will be the value which is passed to the Start Transaction API for the parameter orderRefId. C) transaction_token: This will be a unique transaction token returned on successful COD Start transaction initiation. D) status: 1 indicates the transaction was successful, 0 indicates the transaction was unsuccessful.

Page 2: Zipdial COD API

ZipDial Mobile Solutions Pvt. Ltd.,

No. 63, 3rd

floor, RMZ Gateway, 100 feet road, Koramangala, 4th

Block, Bangalore – 560034 Phone: 080 4142 1921 / 2; Email:[email protected]; Service Tax No : AAACZ4361QSD001; CIN:

U72200KA2010PTC054615

Callback URL - (This will be triggered by Zipdial) On successful COD verification, i.e. when the user respond on the SMS (via missed call) or OBD (via Press, 1/2 option) either accepting or rejecting the COD order, a callback URL given by the customer will be invoked along with the parameters below. Parameters passed on the callback URL are: A) transaction_token: This will be a unique transaction token returned on successful COD Start transaction initiation (This is the value which is returned on invoking Start transaction API) B) orderRefId: This will be the value which is passed to the Start Transaction API for the parameter orderRefId. C) orderStatus: Possible values are 0,1 & 2. 0 - indicates the user has not responded 1 - Indicates the user has accepted the COD order 2 - Indicates the user has rejected the COD order Other Configuration required for COD Verification: 1) Callback URL (Should accept both Get and Post request) 2) SMS Sender ID (6 characters) 3) SMS Response: You have placed an order no. <<ORDER_ID>> on XYZ site for Rs.<<AMOUNT>> for delivery at the address with Pincode <<PIN>>. Zipdial (Missed call) on <<NBR_1>> to confirm or missed call on <<NBR_2>> to deny. 4) OBD Play-text: You have placed an order no. <<ORDER_ID>> on XYZ Site for Rs.<<AMOUNT>> for delivery at the address with Pincode <<PIN>>. Press 1 to confirm or press 2 to reject your order 5) Confirmation SMS: Thank you for your response to XYZ Site. Your order no. <<ORDER_No>> has been <<confirmed/rejected>>. For any further queries please call our support number 0803005XXX Contact Information:

Amit Malhotra Senior Lead: E-commerce Solutions +91-7760967758 (M) [email protected] (E)