FinPay Ultra API Documentation
Integrate Recharge, BBPS, Payout and NSDL PAN APIs with simple REST endpoints.
Developer-first payments infrastructure
FinPay Ultra provides REST endpoints for recharge, BBPS bill fetch and payment, bank payout transfers, and NSDL PAN request workflows. Use secure API tokens from the partner dashboard before calling production services.
Mobile, DTH and gift card recharge
Use this endpoint to initiate Mobile Recharge, DTH Recharge and Gift Card services with a unique reference transaction ID.
Parameters
| Parameter | Description |
|---|---|
| ApiToken | API Token |
| MobileNo | Customer Mobile Number |
| Amount | Recharge Amount |
| OpId | Operator Code |
| RefTxnId | Unique Request ID |
Success Response
{
"STATUS": 1,
"MESSAGE": "Request is successfull!",
"ERRORCODE": "0",
"OPTXNID": "[Operator Txn ID]",
"TXNNO": "[Our OrderID]",
"REQUESTTXNID": "[Your_request_ID]",
"HTTPCODE": 200
}Failed Response
{
"STATUS": 3,
"MESSAGE": "Request is failed! - Error.",
"ERRORCODE": "10",
"TXNNO": "[Our OrderID]",
"REQUESTTXNID": "[Your_request_ID]",
"HTTPCODE": 200
}Supported Services
- Mobile Recharge
- DTH Recharge
- Gift Cards
Bill fetch and bill payment flows
BBPS integrations are split into Bill Fetch and Bill Payment endpoints. Fetch returns bill details; pay submits the payment request.
Section 1: Bill Fetch
Bill Fetch Success Response
{
"STATUS": 1,
"MESSAGE": "Request is processed!",
"REFID": "D220801184350504A51",
"ERRORCODE": "0",
"DATA": {
"Bill_No": "10061",
"Customer": "SH DEEPAK SHYAL",
"Amount": 0.0,
"DueDate": "21-07-2022",
"BillPeriod": null,
"BillDate": "11-07-2022"
},
"PRICE": "0",
"HTTPCODE": 200
}Bill Fetch Failed Response
{
"STATUS": 3,
"ERRORCODE": "20",
"HTTPCODE": 200
}Section 2: Bill Payment
Bill Payment Success Response
{
"STATUS": 1,
"MESSAGE": "Request is successfull!",
"ERRORCODE": "0",
"OPTXNID": "[Operator Txn ID]",
"TXNNO": "[Our OrderID]",
"REQUESTTXNID": "[Your_request_ID]",
"HTTPCODE": 200
}Bill Payment Failed Response
{
"STATUS": 3,
"MESSAGE": "Request is failed! - Error.",
"ERRORCODE": "10",
"TXNNO": "[Our OrderID]",
"REQUESTTXNID": "[Your_request_ID]",
"HTTPCODE": 200
}Bank account money transfer
Submit payout transfers to beneficiary bank accounts using a JSON POST body with account, IFSC, transfer mode and amount information.
Input JSON
{
"ApiToken": "Token",
"orderId": "Agent ID",
"beneficiaryAccount": "Account Number",
"beneficiaryIFSC": "Bank_IFSC_Code",
"amount": "Amount",
"transferMode": "IMPS",
"beneficiaryName": "",
"OpId": "Operator_Code",
"mobileno": "Mobile_number"
}Success Response
{
"STATUS": 1,
"MESSAGE": "Request is successfull!",
"ERRORCODE": "0",
"OPTXNID": "[Operator Txn ID]",
"TXNNO": "[Our OrderID]",
"BENENAME": "",
"REQUESTTXNID": "[Your_request_ID]",
"EZYTMTXNID": "D220615423EA4215",
"HTTPCODE": 200
}Failed Response
{
"STATUS": 3,
"MESSAGE": "Request is failed! - Error.",
"ERRORCODE": "10",
"HTTPCODE": 200
}PAN request redirection APIs
Create New PAN, PAN Correction and Incomplete PAN redirection URLs for customer application flows.
1. New PAN Request
| Parameter | Description |
|---|---|
| TokenId | Partner token ID |
| Number | Customer mobile number |
| Mode | PAN request mode |
| Name | Applicant name |
| Applicant email | |
| Gender | Applicant gender |
| RefTxnId | Unique request ID |
{
"status": "Success",
"message": "Pan Redirection url created",
"url": "PAN_REDIRECTION_URL",
"REQUESTTXNID": "Your_request_ID"
}2. PAN Correction Request
{
"status": "Success",
"message": "Pan Redirection url created",
"url": "PAN_REDIRECTION_URL"
}3. Incomplete PAN Request
{
"status": "Success",
"message": "Pan Redirection url created",
"url": "PAN_REDIRECTION_URL"
}{
"status": "Failure",
"message": "Please enter correct Mobile number, it must be 10 digit"
}Transaction lifecycle states
Use the STATUS field to evaluate the transaction result returned by each API response.
| Code | Meaning |
|---|---|
| 1 | Success |
| 2 | Pending / Processing |
| 3 | Failed |
Error code reference
Use ERRORCODE with STATUS and MESSAGE fields to identify authentication, transaction and bill fetch errors.
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Authentication Failed |
| 10 | Transaction Failed |
| 20 | Bill Fetch Failed |
Partner resources
Use the official website for company information and the partner login portal to access API credentials and merchant tools.