Auth API

A merchant has to get an authentication token before process any API.

Auth API

Merchant can generate an authentication token. He can use that token to authenticate all the other apis.
This Authentication token will be valid for 1 hour.

How to Generate Authentication token?

Auth token generation request has to be sent to our REST endpoint i.e. invoiceServices/REST/v1/authToken using POST method.

In our API Specifications you can find a full list of parameters that can be sent in the initial request.

Sample Request

Language:

curl https://staging.caratipay.com/invoiceServices/REST/v1/authToken \
curl --header "AuthToken:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjb25tZXJjaGFudDEiLCJyb2xlIjoibWVyY2hhbnQiLCJpc3MiOiJQWiIsImV4cCI6MTUwMTE0NjY0MX0.TFmGGKDUgkktmZQvrUTeox1buH1J6lgBVE3Mcy8OVjA"
	-d "authentication.partnerId=195" \
	-d "merchant.username=testdoc" \
	-d "authentication.sKey=secureKey"

Sample Response

Language:

JSON
XML

{
 "partnerId": "195",
 "memberId": "11344",
 "result": {
  "code": "200",
  "description": "Token generated successfully"
 },
 "timestamp": "2018-06-09 12:47:43",
 "LoginName": "testdoc",
 "AuthToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJjb25tZXJjaGFudDEiLCJyb2xlIjoibWVyY2hhbnQiLCJpc3MiOiJQWiIsImV4cCI6MTUwMTE0NjY0MX0.TFmGGKDUgkktmZQvrUTeox1buH1J6lgBVE3Mcy8OVjA"
}