Table of Contents
Instructions
- Request Method (GET, POST) is provided along with each API. Use Methods as directed for each API.
- Request Method (GET, POST) is provided along with each API. Use Methods as directed for each API.
- Your Token needs to be generated by white listing your IP. This token will be used as Authentication for consuming API.
- API Responses will be displayed in JSON format.
Wallet Balance API
Method : POST
Endpoint : https://api.segurapay.in/UserWalletBalance?token={token}
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Response: On successful API Call balance will be provided in string format.
Payout Transfer API
A. NEFT
Method : POST
Endpoint : https://api.segurapay.in/PayoutBankTransafer
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Number | String | Mobile Number of the user |
Amount | Int | Amount to be collected. (In Rupees, Integer value) E.g. : 200 / 300 |
Transfer Mode | String | NEFT |
Account Number | String | Beneficiary Account Number |
IFSC code | String | Beneficiary bank’s IFSC Code- 11 digit |
Beneficiary Name | String | Beneficiary Name |
Order ID | String | Unique Client Transaction Reference Number |
Sample Request:
{ "Token": "sample string 1", "Number": "sample string 2", "Amount": "sample string 3", "TransferMode": "sample string 4", "AccountNo": "sample string 5", "IFSCCode": "sample string 6", "BeneficiaryName": "sample string 7", "OrderID": "sample string 10" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Response Params : (M – Mandatory)
Key | Type | Description |
---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other |
Message | String | Transaction message |
ClientOrderID | Int | Unique Client Transaction Reference Number |
OrderID | String | Unique Transaction Reference Number of segurapay |
BeneficiaryName | String | Beneficiary Account Number |
RRN | String | Bank ref. Number |
Status | String | Transaction Status Success/Pending/Failure |
B. RTGS
Method : POST
Endpoint : https://api.segurapay.in/PayoutBankTransafer
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Number | String | Mobile Number of the user |
Amount | Int | Amount to be collected. (In Rupees, Integer value) E.g. : 200 / 300 |
Transfer Mode | String | RTGS |
Account Number | String | Beneficiary Account Number |
IFSC code | String | Beneficiary bank’s IFSC Code- 11 digit |
Beneficiary Name | String | Beneficiary Name |
Order ID | String | Unique Client Transaction Reference Number |
Sample Request:
{ "Token": "sample string 1", "Number": "sample string 2", "Amount": "sample string 3", "TransferMode": "sample string 4", "AccountNo": "sample string 5", "IFSCCode": "sample string 6", "BeneficiaryName": "sample string 7", "OrderID": "sample string 10" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Response Params : (M – Mandatory)
Key | Type | Description |
---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other |
Message | String | Transaction message |
ClientOrderID | Int | Unique Client Transaction Reference Number |
OrderID | String | Unique Transaction Reference Number of segurapay |
BeneficiaryName | String | Beneficiary Account Number |
RRN | String | Bank ref. Number |
Status | String | Transaction Status Success/Pending/Failure |
C. IMPS
Method : POST
Endpoint : https://api.segurapay.in/PayoutBankTransafer
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Number | String | Mobile Number of the user |
Amount | Int | Amount to be collected. (In Rupees, Integer value) E.g. : 200 / 300 |
Transfer Mode | String | IMPS |
Account Number | String | Beneficiary Account Number |
IFSC code | String | Beneficiary bank’s IFSC Code- 11 digit |
Beneficiary Name | String | Beneficiary Name |
Order ID | String | Unique Client Transaction Reference Number |
Sample Request:
"Token": "sample string 1", "Number": "sample string 2", "Amount": "sample string 3", "TransferMode": "sample string 4", "AccountNo": "sample string 5", "IFSCCode": "sample string 6", "BeneficiaryName": "sample string 7", "OrderID": "sample string 10" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Response Params : (M – Mandatory)
Key | Type | Description |
---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other |
Message | String | Transaction message |
ClientOrderID | Int | Unique Client Transaction Reference Number |
OrderID | String | Unique Transaction Reference Number of segurapay |
BeneficiaryName | String | Beneficiary Account Number |
RRN | String | Bank Ref. Number |
Status | String | Transaction Status Success/Pending/Failure |
D. UPI
Method : POST
Endpoint : https://api.segurapay.in/PayoutBankTransafer
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Number | String | Mobile Number of the user |
Amount | Int | Amount to be collected. (In Rupees, Integer value) E.g. : 200 / 300 |
Transfer Mode | String | UPI |
UPIId | String | UPI ID |
BeneficiaryPhoneNo | String | Beneficiary mobile number (Optional) |
Beneficiary Name | String | Beneficiary Name |
Order ID | String | Unique Client Transaction Reference Number |
Note: You need to pass either UPI Id or Beneficiary mobile number.
Sample Request:
{ "Token": "sample string 1", "Number": "sample string 2", "Amount": "sample string 3", "TransferMode": "sample string 4", "BeneficiaryName": "sample string 7", "UPIId": "sample string 8", "BeneficiaryPhoneNo": "sample string 9", "OrderID": "sample string 10" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Response Params : (M – Mandatory)
Key | Type | Description |
---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other |
Message | String | Transaction message |
ClientOrderID | Int | Unique Client Transaction Reference Number |
OrderID | String | Unique Transaction Reference Number of SeguraPay |
BeneficiaryName | String | Beneficiary Account Number |
RRN | String | Bank ref. Number |
Status | String | Transaction Status Success/Pending/Failure |
Status Check API
A. Using client Reference ID
Method : POST
Endpoint : https://api.segurapay.in/PayoutTransactionStatusByClientRef
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Order ID | String | Unique Client Transaction Reference Number |
Sample Request:
{ "Token": "sample string 1", "OrderID": "sample string 2" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Request Params: (M – Mandatory)
Key | Type | Description | |
---|---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other | |
Message | String | Transaction message | |
ClientOrderID | String | Unique Client Transaction Reference Number | |
OrderID | String | Unique Transaction Reference Number | |
BeneficiaryName | String | Beneficiary Account Number | |
RRN | String | RRN | |
Status | String | Transaction Status Success/Pending/Failure/Reversal |
B. Using SeguraPay Reference ID
Method : POST
Endpoint : https://api.segurapay.in/PayoutTransactionStatusByOrderID
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Order ID | String | Unique Client Transaction Reference Number |
Sample Request:
{ "Token": "sample string 1", "OrderID": "sample string 2" }
Sample Response:
{ "StatusCode": 1, "Message": "Transaction Successful", "Data": { "ClientOrderID": "1223234", "OrderID": "188020200", "BeneficiaryName": "RUPESH KUMAR VIRENDR", "RRN": "036516753713", "Status": "Success" }
Request Params: (M – Mandatory)
Key | Type | Description | |
---|---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other | |
Message | String | Transaction message | |
ClientOrderID | String | Unique Client Transaction Reference Number | |
OrderID | String | Unique Transaction Reference Number of SeguraPay | |
BeneficiaryName | String | Beneficiary Account Number | |
RRN | String | Bank ref. Number | |
Status | String | Transaction Status Success/Pending/Failure |
Webhooks
It might happen that SeguraPay might call webhook multiple times with the same parameters. You are requested to handle such cases at your end using a client transaction ref field.
Method : GET
Sample Request:
https://yourdomain.com/callbackurl?clientTxnRef=Se123456&refId=1900000211&status=Success& operatorRef=AND12345
Key | Type | Description |
---|---|---|
clientTxnRef | Int | Unique Client Transaction Reference Number |
refId | String | Unique Transaction Reference Number of SeguraPay |
status | String | Success/Pending/Failure/Reversal |
operatorRef | String | Bank ref. number |
Raise Complaint
Method : POST
Endpoint : https://api.SeguraPay.in/RaiseComplaint
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
token(M) | String | Generated token |
Subject | String | Subject |
Message | String | Message |
OrderId | String | Unique Transaction Reference Number of SeguraPay |
Sample Request:
{ "Token": "sample string 1", "Subject": "sample string 2", "Message": "sample string 3", "OrderId": "sample string 4" }
Sample Response:
{ "StatusCode": 1, "Message": "Success", }
Request Params: (M – Mandatory)
Key | Type | Description |
---|---|---|
StatusCode | Int | Success:1, Failed:0 & Pending: other |
Message | String | Transaction message |