This endpoint retrieves contribution details for a specific employer, along with all eligible employees for contribution, allowing HR/Admin to obtain comprehensive information regarding employee contributions within a specified date range/specific month.
\nMethod: POST
\nURL: {{awsURL}}/v1/contribution/fetchContributionDetails
The request body should be in JSON format and include the following parameters:
\nemployerId (string): The unique identifier for the employer.
\nfromDate (string): The start date for fetching payroll details in the format YYYY/MM/DD HH:mm:ss.
toDate (string): The end date for fetching payroll details in the format YYYY/MM/DD HH:mm:ss.
page_number (integer): The page number for pagination of results.
\nnoLimit (boolean): A flag indicating whether to limit the number of results returned.
\nmiddlewareFor (string): Indicates the middleware context, e.g., \"corporate\".
\nThe response for this request follows the JSON schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"totalContributionInAmount\": { \"type\": \"number\" },\n \"totalEmployerContribution\": { \"type\": \"number\" },\n \"totalEmployeeContribution\": { \"type\": \"number\" },\n \"employeeContributionDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": { \"type\": \"string\" },\n \"lastName\": { \"type\": \"string\" },\n \"contactNumber\": { \"type\": \"string\" },\n \"employeeId\": { \"type\": \"string\" },\n \"email\": { \"type\": \"string\" },\n \"userid\": { \"type\": \"string\" },\n \"createdAt\": { \"type\": \"string\" },\n \"corporateEmployeeDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"employee_basic_salary\": { \"type\": \"number\" },\n \"employeeNPSContributionPercentage\": { \"type\": \"number\" }\n }\n },\n \"npsAccountStatus\": {\n \"type\": \"object\",\n \"properties\": {\n \"tier1SectorCd\": { \"type\": \"string\" },\n \"tier1PopRegNo\": { \"type\": \"string\" },\n \"pran\": { \"type\": \"string\" }\n }\n },\n \"registrationDetails\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"registrationStatus\": { \"type\": \"string\" }\n }\n }\n },\n \"employeeContributionPerMonth\": { \"type\": \"string\" },\n \"employerContributionPerMonth\": { \"type\": \"string\" }\n }\n }\n },\n \"page\": { \"type\": \"number\" },\n \"corporateTransactionDetails\": {\n \"type\": \"object\",\n \"properties\": {\n \"createdAt\": { \"type\": \"string\" },\n \"acquirer_data\": {\n \"type\": \"object\",\n \"properties\": {\n \"bank_transaction_id\": { \"type\": \"string\" }\n }\n },\n \"amountInPaise\": { \"type\": \"number\" },\n \"paymentId\": { \"type\": \"string\" },\n \"bank\": { \"type\": \"string\" },\n \"orderId\": { \"type\": \"string\" }\n }\n }\n }\n },\n \"message\": { \"type\": \"string\" },\n \"statusCode\": { \"type\": \"number\" }\n }\n}\n\nThis endpoint allows the corporate to create a payment order for payroll contributions for a specified month and year.
\nThe request should be sent as a JSON object with the following parameters:
\npayrollMonth (string): The month for which the payroll is being processed, formatted as MM (e.g., \"08\" for August).
payrollYear (string): The year for which the payroll is being processed, formatted as YYYY (e.g., \"2025\").
employerId (string): The unique identifier of the employer.
base64Obj (object): An object containing the payroll document details:
name (string): The name of the document (e.g., \"August_2025_Payroll.pdf\").
basePdf64Data (string): The base64 encoded data of the PDF document.
documentType (string): The type of document being submitted (e.g., \"paymentReceipt\").
paymentId (string): The unique identifier for the payment.
totalPayrollAmount (string): The total amount for the payroll, formatted as a string (e.g., \"1250000.00\").
middlewareFor (string): Indicates the middleware context (e.g., corporate).
The response will be a JSON object containing the following fields:
\ndata (object): Contains the details of the processed payroll contributions:
status (string): The status of the payroll processing.
payroll (object): Details about the payroll:
month (string): The month of the payroll.
year (string): The year of the payroll.
totalAmount (string): The total amount processed for the payroll.
employerId (string): The unique identifier of the employer.
payment (object): Details of the payment:
id (string): The unique identifier for the payment.
receiptId (string): The receipt identifier for the payment.
bankTransfer (object): Information regarding bank transfer status:
status (string): The status of the bank transfer.contributions (object): Details about employee contributions:
employeesCount (integer): The number of employees processed.
createdRecords (array): An array of records for each employee contribution, containing:
employeeId (string): The unique identifier of the employee.
employeeName (string): The name of the employee.
employeeContribution (string): The contribution amount from the employee.
employerContribution (string): The contribution amount from the employer.
totalContribution (string): The total contribution amount.
payrollType (string): The type of payroll (e.g., regular, bonus).
message (string): A message related to the response.
statusCode (integer): The status code of the response.
Make sure to include the following headers in your request:
\nContent-Type: Set this to application/json to indicate that the request body format is JSON.
Authorization: Include any necessary authorization token required for accessing the endpoint.
{\n \"payrollMonth\": \"08\",\n \"payrollYear\": \"2025\",\n \"employerId\": \"ee9a8be0-d9c3-4d44-8ae9-550d74...\",\n \"base64Obj\": {\n \"name\": \"August_2025_Payroll.pdf\",\n \"basePdf64Data\": \"JVBERi0xLjUKJcTl8uXr...\",\n \"documentType\": \"paymentReceipt\"\n },\n \"paymentId\": \"PAY987654321\",\n \"totalPayrollAmount\": \"1250000.00\",\n \"middlewareFor\": \"corporate\"\n}\n\n{\n \"data\": {\n \"status\": \"\",\n \"payroll\": {\n \"month\": \"\",\n \"year\": \"\",\n \"totalAmount\": \"\"\n },\n \"employerId\": \"\",\n \"payment\": {\n \"id\": \"\",\n \"receiptId\": \"\"\n },\n \"bankTransfer\": {\n \"status\": \"\"\n },\n \"contributions\": {\n \"employeesCount\": 0,\n \"createdRecords\": [\n {\n \"employeeId\": \"\",\n \"employeeName\": \"\",\n \"employeeContribution\": \"\",\n \"employerContribution\": \"\",\n \"totalContribution\": \"\",\n \"payrollType\": \"\"\n }\n ]\n }\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\nThis endpoint allows you to fetch contribution history for corporate entities. It fetch contribution history within a specified date range and returns detailed information about employee contributions details.
\nThe request body must be in JSON format and should include the following parameters:
\nemployerId (string): Unique identifier for the employer.
fromDate (string): The start date for the payroll period in the format YYYY/MM/DD HH:mm:ss.
toDate (string): The end date for the payroll period in the format YYYY/MM/DD HH:mm:ss.
middlewareFor (string): Indicates the type of middleware being used, e.g., \"corporate\".
Example of a request body:
\n{\n \"employerId\": \"ee9a8be0-d9c3-4d44-8ae9-550d74...\",\n \"fromDate\": \"2025/09/01 00:00:00\",\n \"toDate\": \"2025/09/30 23:59:59\",\n \"middlewareFor\": \"corporate\"\n}\n\nThe response will be a JSON object containing the following structure:
\ndata (object): Contains details about the payroll transactions.
employeesContributionDetails (array): An array of objects detailing employee contributions.
totalContribution (string): Total contribution amount.
employerContribution (string): Contribution amount from the employer.
employeeContribution (string): Contribution amount from the employee.
employee_id (string): Unique identifier for the employee.
employee_name (string): Name of the employee.
employee_email (string): Email of the employee.
employee_userid (string): User ID of the employee.
gstCharges (string): GST charges applicable.
popCharges (string): Charges related to POP.
registrationCharges (string): Registration charges.
payrollType (string): Type of payroll.
paymentId (string): Unique identifier for the payment.
employee_contact_no (string): Contact number of the employee.
transactionDetails (array): An array of objects detailing the transaction.
id (number): Unique identifier for the transaction.
paymentId (string): ID of the payment.
orderId (string): ID of the order associated with the transaction.
createdAt (string): Timestamp of when the transaction was created.
bank (string): Bank associated with the transaction.
amountInPaise (number): Amount of the transaction in paise.
acquirer_data (object): Data from the acquirer.
card (string): Card information if applicable.
card_id (string): ID of the card used in the transaction.
vpa (string): Virtual Payment Address if applicable.
upi (string): UPI information if applicable.
method (string): Payment method used.
payrollType (string): Type of payroll for the transaction.
message (string): A message indicating the status of the request.
statusCode (number): The HTTP status code of the response.
The HTTP POST request to {{awsURL}}/v1/corporate/nps/npsAccountStatus is used to retrieve the account status information for a corporate National Pension System (NPS) account.
This request requires authentication using a Bearer Token. The Bearer Token should be included in the Authorization header of the request.
Example of the Authorization header:
\nAuthorization: Bearer <token>\n\nEnsure that the token is valid and obtained from the authentication server.
\nemployerId (string, required): The ID of the employer associated with the NPS account.
partnerId (string, required): The ID of the partner associated with the NPS account.
employeeId (string, required): The ID of the user for whom the account status is being retrieved.
mobile_number (string): The mobile number of the user.
middlewareFor (string, required): Identifier used to determine the purpose of the token — for example, whether it is for a corporate or partner.
The response for this request is in JSON format and includes the following fields:
\n{\n \"data\": {\n \"username\": \"\",\n \"pran\": \"\",\n \"tier1Sts\": \"\",\n \"tier1StsCode\": \"\",\n \"tier2Sts\": \"\",\n \"tier2StsCode\": \"\",\n \"tier1SectorCd\": \"\",\n \"tier1PopRegNo\": \"\",\n \"tier1PopSpRegNo\": \"\",\n \"tier2SectorCd\": \"\",\n \"tier2PopRegNo\": \"\",\n \"tier2PopSpRegNo\": \"\",\n \"craType\": \"\",\n \"nriFlag\": \"\",\n \"PRANgeneration\": \"\"\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"username\": { \"type\": \"string\" },\n \"pran\": { \"type\": \"string\" },\n \"tier1Sts\": { \"type\": \"string\" },\n \"tier1StsCode\": { \"type\": \"string\" },\n \"tier2Sts\": { \"type\": \"string\" },\n \"tier2StsCode\": { \"type\": \"string\" },\n \"tier1SectorCd\": { \"type\": \"string\" },\n \"tier1PopRegNo\": { \"type\": \"string\" },\n \"tier1PopSpRegNo\": { \"type\": \"string\" },\n \"tier2SectorCd\": { \"type\": \"string\" },\n \"tier2PopRegNo\": { \"type\": \"string\" },\n \"tier2PopSpRegNo\": { \"type\": \"string\" },\n \"craType\": { \"type\": \"string\" },\n \"nriFlag\": { \"type\": \"string\" },\n \"PRANgeneration\": { \"type\": [\"string\", \"DD/MM/YYYY\"] }\n }\n },\n \"message\": { \"type\": \"string\" },\n \"statusCode\": { \"type\": \"number\" }\n } \n\nThis endpoint allows the user to submit a new NPS (National Pension System) portfolio related to corporate accounts.
\nemployerId (string, required): The ID of the employer associated with the NPS portfolio.
partnerId (string, required): The ID of the partner associated with the NPS portfolio.
employeeId (string, required): The ID of the user
associated with the NPS portfolio.
\nmobile_number (string): The mobile number of the user.
tierType (string,optional): Use this to filter data based on the Tier type. Accepted values are \"TIER-I\" or \"TIER-II\".
middlewareFor (string, required): Identifier used to determine the purpose of the token — for example, whether it is for a corporate, partner.
Response
\nThe response for this request is a JSON object with the following schema:
\n{\n \"data\": [\n {\n \"Account_Type\": \"\",\n \"PFM_Code\": \"\",\n \"Scheme_Code\": \"\",\n \"Closing_Units\": \"\",\n \"Closing_Balance\": \"\",\n \"nav\": \"\",\n \"date\": \"\",\n \"scheme_name\": \"\",\n \"fund_name\": \"\",\n \"updatedAt\": \"\",\n \"PercentageAllocation\":\"\"\n }\n ],\n \"message\": \"\",\n \"statusCode\": 0\n}\n\nThe data field contains an array of objects, each representing a specific NPS portfolio. The fields within each object provide details such as account type, scheme code, closing units, closing balance, NAV (Net Asset Value), date, scheme name, fund name, and the last update timestamp.
This endpoint is used to submit a request for user mandates in the corporate NPS system.
\nemployerId (text, optional): The ID of the employer.
partnerId (text, optional): The ID of the partner.
employeeId (text, optional): The ID of the user.
mobile_number (string): The mobile number of the user.
page (number, required): The page number.
mandateid (text, optional): The ID of the mandate.
typeOfTier (text, optional): The type of tier.
statusOfSIP (text, optional): The status of SIP.
startDate (text, optional): The start date.
endDate (text, optional): The end date.
timeRange (text, optional): The time range.
middlewareFor (string): Indicates the middleware context (e.g., corporate).
The response is in JSON format and follows the schema below:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"array\",\n \"items\": {\n \"type\": \"object\",\n \"properties\": {\n \"id\": { \"type\": \"number\" },\n \"userid\": { \"type\": \"string\" },\n \"mercid\": { \"type\": [\"null\", \"number\"] },\n \"mandateid\": { \"type\": \"string\" },\n \"mandate_tokenid\": { \"type\": [\"null\", \"string\"] },\n \"start_date\": { \"type\": \"string\" },\n \"end_date\": { \"type\": \"string\" },\n \"debit_day\": { \"type\": \"string\" },\n \"frequency\": { \"type\": \"string\" },\n \"payment_method_type\": { \"type\": \"string\" },\n \"card\": { \"type\": [\"null\", \"object\"] },\n \"upi\": { \"type\": \"string\" },\n \"netbanking\": { \"type\": [\"null\", \"object\"] },\n \"wallet\": { \"type\": [\"null\", \"object\"] },\n \"bankaccount\": { \"type\": [\"null\", \"object\"] },\n \"amount\": { \"type\": \"string\" },\n \"actualAmount\": { \"type\": \"string\" },\n \"ru\": { \"type\": [\"null\", \"string\"] },\n \"subscription_desc\": { \"type\": [\"null\", \"string\"] },\n \"verification_error_type\": { \"type\": [\"null\", \"string\"] },\n \"createdon\": { \"type\": [\"null\", \"string\"] },\n \"bank_umrn\": { \"type\": [\"null\", \"string\"] },\n \"customer_refid\": { \"type\": [\"null\", \"string\"] },\n \"amount_type\": { \"type\": [\"null\", \"string\"] },\n \"nps_account_type\": { \"type\": \"string\" },\n \"verification_error_code\": { \"type\": [\"null\", \"string\"] },\n \"subscription_refid\": { \"type\": [\"null\", \"string\"] },\n \"currency\": { \"type\": \"string\" },\n \"recurrence_rule\": { \"type\": [\"null\", \"string\"] },\n \"objectid\": { \"type\": [\"null\", \"string\"] },\n \"verification_error_desc\": { \"type\": [\"null\", \"string\"] },\n \"status\": { \"type\": \"string\" },\n \"customer\": {\n \"type\": \"object\",\n \"properties\": {\n \"email\": { \"type\": \"string\" },\n \"contact\": { \"type\": \"string\" }\n }\n },\n \"action\": { \"type\": [\"null\", \"string\"] },\n \"mandate_edit\": { \"type\": [\"null\", \"string\"] },\n \"autoDebit\": { \"type\": \"string\" },\n \"entity\": { \"type\": \"string\" },\n \"current_start\": { \"type\": [\"null\", \"string\"] },\n \"current_end\": { \"type\": [\"null\", \"string\"] },\n \"quantity\": { \"type\": [\"null\", \"number\"] },\n \"auth_attempts\": { \"type\": [\"null\", \"number\"] },\n \"total_count\": { \"type\": [\"null\", \"number\"] },\n \"paid_count\": { \"type\": [\"null\", \"number\"] },\n \"customer_notify\": { \"type\": [\"null\", \"string\"] },\n \"created_at\": { \"type\": \"string\" },\n \"expire_by\": { \"type\": [\"null\", \"string\"] },\n \"subscription_url\": { \"type\": [\"null\", \"string\"] },\n \"has_scheduled_changes\": { \"type\": [\"null\", \"string\"] },\n \"change_scheduled_at\": { \"type\": [\"null\", \"string\"] },\n \"source\": { \"type\": [\"null\", \"string\"] },\n \"remaining_count\": { \"type\": [\"null\", \"number\"] },\n \"charge_at\": { \"type\": [\"null\", \"string\"] },\n \"plan_id\": { \"type\": [\"null\", \"string\"] },\n \"offer_id\": { \"type\": [\"null\", \"string\"] },\n \"customer_id\": { \"type\": \"string\" },\n \"short_url\": { \"type\": [\"null\", \"string\"] },\n \"notes\": {\n \"type\": \"array\",\n \"items\": { \"type\": \"string\" }\n },\n \"acquirer_data\": {\n \"type\": \"object\",\n \"properties\": {\n \"rrn\": { \"type\": \"string\" },\n \"upi_transaction_id\": { \"type\": \"string\" }\n }\n },\n \"bank_details\": { \"type\": [\"null\", \"object\"] },\n \"max_amount\": { \"type\": [\"null\", \"string\"] },\n \"expired_at\": { \"type\": [\"null\", \"string\"] },\n \"start_time\": { \"type\": [\"null\", \"string\"] },\n \"used_at\": { \"type\": [\"null\", \"string\"] },\n \"auth_type\": { \"type\": [\"null\", \"string\"] },\n \"mrn\": { \"type\": [\"null\", \"string\"] },\n \"createdAt\": { \"type\": \"string\" },\n \"updatedAt\": { \"type\": \"string\" },\n \"deletedAt\": { \"type\": [\"null\", \"string\"] }\n }\n }\n },\n \"message\": { \"type\": \"string\" },\n \"statusCode\": { \"type\": \"number\" }\n }\n}\n\nThis endpoint is used to retrieve the Statement of Transaction (SOT) for a corporate entity.
\nemployerId (string): The unique identifier of the employer.
partnerId (string): The unique identifier of the partner.
employeeId (string): The identifier of the user.
mobile_number (string): The mobile number of the user.
responseType (string): The type of response to be generated. Possible values are:
A: Direct download in binary
\nP: Send SOT PDF(s) to email id of POP
\nS: Send SOT PDF(s) to subscriber's email
\nFromdate (string): The start date for the SOT.
Todate (string): The end date for the SOT.
AccountType (number): The type of NPS account. 1 for NPS Tier 1 or Tier 2 account.
middlewareFor (string): Indicates the middleware context (e.g., corporate).
The response is in JSON format with the following schema:
\n{\n \"data\": {\n \"Status\": {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n \"Details\": {\n \"PRAN\": \"\",\n \"ResultID\": \"\",\n \"Message\": \"\"\n },\n \"base64PDfString\": \"\"\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\ndata (object): The data object containing status, details, and base64 encoded PDF string.
Status (object or array of objects): The status of the request with a code and message.
Details (object or array of objects): Additional details such as PRAN, ResultID, and message.
base64PDfString (string): The base64 encoded PDF string if responseType is A or P.
message (string): Additional message, if any.
statusCode (number): The status code of the response.
{\n \"data\": {\n \"Status\": {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n \"Details\": {\n \"PRAN\": \"\",\n \"ResultID\": \"\",\n \"Message\": \"\"\n },\n \"base64PDfString\": \"\"\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\nThis endpoint allows users to retrieve detailed performance metrics for a specific fund on a given date. It is particularly useful for investors and fund managers who need to analyze the performance of their investments over time.
\nMethod: POST
\nURL: {{awsURL}}/v1/nps/nav/fetchFundPerformanceDetails
The request body must be a JSON object containing the following parameter:
\nToday (string,required): The date for which the fund performance details are requested, formatted as DD-MM-YYYY. For example, \"22-07-2025\".
middlewareFor (string, required): Identifier used to determine the purpose of the token — for example, whether it is for a corporate, partner.
The response will contain detailed information regarding the fund's performance on the specified date. The structure of the response will typically include:
\ndata: An object containing the performance metrics for the fund.
\nFundPerformance: An array of objects, each representing the performance details of a specific fund. Each object includes:
\nAccount type (string): The type of account (e.g., \"Tier-I\").
\nPFM Name (string): The name of the fund management company.
\nScheme Name (string): The name of the specific fund scheme.
\nScheme type (string): The type of scheme (e.g., \"Scheme A\").
\nDate (string): The date for which the performance data is relevant, formatted as ISO 8601.
\n6 month CAGR (number): The compound annual growth rate over the last 6 months.
\n1 year CAGR (number): The compound annual growth rate over the last year.
\n3 year CAGR (number): The compound annual growth rate over the last 3 years.
\n5 year CAGR (number): The compound annual growth rate over the last 5 years.
\nSince inception CAGR (number): The compound annual growth rate since the fund's inception.
\nInception date (string): The date when the fund was launched, formatted as ISO 8601.
\nCurrent NAV date (string): The date for the current NAV value, formatted as ISO 8601.
\nCurrent NAV (number): The current net asset value of the fund.
\nmessage (string): A message indicating the status of the request (e.g., \"Success\").
\nstatusCode (number): The HTTP status code of the response (e.g., 200).
\nExample Response:
\n{\n \"data\": {\n \"FundPerformance\": [\n {\n \"Account type\": \"Tier-I\",\n \"PFM Name\": \"Aditya Birla Sun Life Pension Management Limited\",\n \"Scheme Name\": \"Aditya Birla Sunlife Pension Fund Scheme A - Tier I\",\n \"Scheme type\": \"Scheme A\",\n \"Date\": \"2025-07-22T00:00:00\",\n \"6 month CAGR\": 0,\n \"1 year CAGR\": 0,\n \"3 year CAGR\": 2.68,\n \"5 year CAGR\": 3.31,\n \"Since inception CAGR\": 4.68,\n \"Inception date\": \"2017-05-05T00:00:00\",\n \"Current NAV date\": \"2025-03-21T00:00:00\",\n \"Current NAV\": 14.3099\n }\n ]\n },\n \"message\": \"Success\",\n \"statusCode\": 200\n}\n\n\"content-type\":\"application/json\"
\"X-Signature\": \"xxxxxxxxx\"
“X-Signature” - To ensure that your API endpoint is verifying that incoming POST requests are from PensionBox and not a malicious source, and that payloads haven't been altered in transit.
\nIt is generated using string secret_key and payload data. You can look at the code snippet to generate and match the encoded hash data generated using hmac module and sha256.
\nCode Snippet:
\nimport hmac\nimport hashlib\nimport json\n# Example secret key and message\napp_key = \"my_secret_key\"\npayload = request.body\ntry:\n pensionBox_signature = request.headers.get(\"X-Signature\")\nexcept KeyError:\n print('No signature sent, request did not originate from Tartan.')\n raise\nprint(\"Recieved X-Signature:\", pensionBox_signature)\n# Generate HMAC digest using SHA256\nhmac_digest = hmac.new(app_key.encode(\"utf-8\"), payload.encode(\"utf-8\"), hashlib.sha256).hexdigest()\nprint(\"Generated HMAC Digest:\", hmac_digest)\n# Check if the generated HMAC matches the received one\nif hmac_digest == pensionBox_signature:\n print(\"HMAC verified successfully!\")\nelse:\n print(\"HMAC verification failed!\")\n\nTo start receiving webhook events from PensionBox, you must first register your webhook URL and secret with the PensionBox team. Once registered, a UAT (User Acceptance Testing) account will be provided to test the integration. After successful testing, you will begin receiving webhook events triggered by PensionBox.
\nThe supported events include:
\nwebhhook.payment.success
webhhook.payment.failed
webhhook.contribution.success
webhhook.contribution.failed
webhhook.contribution.settled
webhhook.refund.pending
webhhook.refund.processed
webhhook.refund.failed
This endpoint allows you to register a corporate entity.
\nRequest Body
\nfirstName (string, required): The first name of the contact person.
contactNumber (string, required): The contact number of the corporate entity.
email (string, required): The email address of the contact person.
brandName (string, required): The brand name of the corporate entity.
partnerId (string, required): The partner ID of the corporate entity.
middlewareFor (string): Indicates the middleware context (e.g., corporate).
Response
The response will include the status of the registration process.
Response Schema
\n{\n \"type\": \"object\",\n \"properties\": {\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"firstName\": {\n \"type\": \"string\"\n },\n \"lastName\": {\n \"type\": [\"string\", \"null\"]\n },\n \"contactNumber\": {\n \"type\": \"string\"\n },\n \"email\": {\n \"type\": \"string\"\n },\n \"brandName\": {\n \"type\": \"string\"\n },\n \"employerId\": {\n \"type\": \"string\"\n },\n \"partnerId\": {\n \"type\": \"string\"\n },\n \"entityType\": {\n \"type\": \"string\"\n }\n }\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"statusCode\": {\n \"type\": \"number\"\n }\n }\n}\n\nThis endpoint retrieves the account status for a specific employer by making an HTTP GET request to the specified URL. The employerId path parameter should be replaced with the unique identifier of the employer whose account status is being queried.
This request does not require a request body.
\nkyc_status: (string) The kyc status of the employer's account.
corporate_nps_status:(string) Status of Corporate NPS of 0=Form Not Submitted, 1=InProgess,2=Correction,3=Verified
document_mou: (string) Not Submitted , 0=Form in review , 1=Submitted
document_cho: (string) Not Submitted , 0=Form in review , 1=Submitted
document_cancelled_cheque :(string) Not Submitted , 0=Form in review , 1=Submitted
document_cho_signed: (string) Not Submitted , 0=Form in review , 1=Submitted
This endpoint is used to sign up a corporate user.
\nemployerId (text, required): The employer ID of the user.
\npartnerId (text, required): The partner ID of the user.
\ncontactNumber (text, required): The contact number of the user.
\nemail (text, optional): The email address of the user.
\nfirstName (text, optional): The first name of the user.
\nlastName (text, optional): The last name of the user.
\nmiddlewareFor (string): Indicates the middleware context (e.g., corporate).
The response of this request is a JSON schema representing the structure of the response data. It includes the properties and data types expected in the response.
\n","urlObject":{"path":["v1","user","sign-in"],"host":["{{awsURL}}"],"query":[],"variable":[]}},"response":[{"id":"322ed02d-ff0c-4e95-a662-7b2ad8380ddc","name":"Partner user sign-in","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partnerId\": \"83155640-8dfe-47d8-8570-41ca33035f54\",\n \"contactNumber\": \"8307208698\",\n \"email\": \"kunal.mehla@pensionbox.in\", // optional\n \"firstName\": \"kunal\", // optional\n \"lastName\": \"mehla\" // optional\n}\n","options":{"raw":{"language":"json"}}},"url":"{{awsURL}}/v1/user/sign-in"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"807"},{"key":"ETag","value":"W/\"327-trjlOiq6KRBHHnzeprTy0M7tfTE\""},{"key":"Date","value":"Tue, 18 Jun 2024 10:22:38 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"User signed in successfully\",\n \"data\": {\n \"partnerId\": \"83155640-8dfe-47d8-8570-41ca33035f54\",\n \"contactNumber\": \"8307208698\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n }\n}\n"}],"_postman_id":"fb51a57c-228a-4f99-bb36-d4e9c89ce3a9"},{"name":"Fetch Partner/Corporate user details","id":"6cacd0a4-45cd-4f0d-a5fc-ffaf5044eb6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-Api-key","value":"Key will be provided from PensionBox","type":"text"}],"body":{"mode":"raw","raw":"{\n // Required if 'partnerId' is not provided\n \"employerId\": \"263c5319-d43c-420f-b89e-54eacd8c66fc\",\n\n // Required if 'employerId' is not provided\n \"partnerId\": \"f4dd77f2-538f-4c3c-9eb5-0ecccbbcf59a\",\n\n // Required if 'mobile_number' is not provided\n \"employeeId\": \"34002\",\n\n // Required if 'employeeId' is not provided\n \"mobile_number\": \"8307206668\",\n\n // Required: Set to \"partner\" if coming from partner, \"corporate\" if from employer\n \"middlewareFor\": \"corporate\"\n}\n\n","options":{"raw":{"language":"json"}}},"url":"{{awsURL}}/v1/userDetails","description":"This HTTP POST request is used to submit user details for a corporate employee, specifically identified by the mobile_number and employerId. The purpose of this request is to retrieve comprehensive information regarding the user status, including KYC details and retirement savings.
The request body must be in JSON format and should contain the following parameters:
\nmobile_number (string): The mobile number of the user.
employeeId (string): The employeeId associated with the user.
employerId (string): The unique identifier for the employer associated with the user.
partnerId (string): The unique identifier for the partner associated with the user.
⚠️ Important Validation Rules:
\nEither mobile_number or employeeId must be provided.
Either employerId or partnerId must be provided.
If both values in either group are missing, the request will be rejected.
\nExample Request Body:
\n{\n // Required if 'employeeId' is not provided\n \"mobile_number\": \"string\",\n // Required if 'mobile_number' is not provided\n \"employeeId\": \"string\",\n // Required if 'partnerId' is not provided\n \"employerId\": \"string\",\n // Required if 'employerId' is not provided\n \"partnerId\": \"string\"\n}\n\nThe response will be in JSON format and contains the following fields:
\ndata: An object that includes:
employerId: The ID of the employer associated with the user.
partnerId: The ID of the partner associated with the user.
kyc_status: The KYC status of the user.
email: The email address of the user.
contactNumber: The contact number of the user.
npsAccountStatus: An object containing various NPS account status details such as:
username: The username associated with the NPS account.
pran: The Permanent Retirement Account Number.
tier1Sts: The status of Tier 1 NPS account.
tier1StsCode: The code for Tier 1 status.
tier1StsReasonCd: Reason code for Tier 1 status.
tier2Sts: The status of Tier 2 NPS account.
tier2StsCode: The code for Tier 2 status.
tier2StsReasonCd: Reason code for Tier 2 status.
iraFlag: Flag indicating IRA status.
fatcaFlag: Flag indicating FATCA status.
Additional fields related to NPS account status.
\ncorporateEmployeeDetails: An object containing details related to the employee's basic salary, including:
employee_basic_salary: The basic salary of the employee.
employeeNPSContributionPercentage: The percentage of NPS contribution by the employee.
optIn: A boolean indicating if the employee has opted in.
registrationDetails: An object containing:
registrationStatus: The status of the registration.
Details: An array of registration detail objects.
Status: An array of status objects.
totalRetirementSavings: The total retirement savings of the user.
message: A string containing any additional information regarding the request.
statusCode: A numeric code indicating the status of the request.
{\n \"data\": {\n \"employerId\": \"\",\n \"partnerId\":\"\".\n \"kyc_status\": \"\",\n \"email\": \"\",\n \"contactNumber\": \"\",\n \"npsAccountStatus\": {\n \"username\": \"\",\n \"pran\": \"\",\n \"tier1Sts\": \"\",\n \"tier1StsCode\": \"\",\n \"tier1StsReasonCd\": null,\n \"tier2Sts\": null,\n \"tier2StsCode\": null,\n \"tier2StsReasonCd\": \"\",\n \"tier1SectorCd\": \"\",\n \"tier1PopRegNo\": \"\",\n \"tier1PopSpRegNo\": \"\",\n \"tier2SectorCd\": null,\n \"tier2PopRegNo\": null,\n \"tier2PopSpRegNo\": null,\n \"iraFlag\": \"\",\n \"fatcaFlag\": \"\",\n \"fieldErrors\": null,\n \"craType\": \"\",\n \"nriFlag\": \"\",\n \"typeOfBankForT1\": null,\n \"typeOfBankForT2\": null,\n \"dob\": null,\n \"praoSchOpt\": null,\n \"defASPFlag\": null,\n \"defLumpsumFlag\": null,\n \"contFlag\": null\n },\n \"corporateEmployeeDetails\": {\n \"employee_basic_salary\": 0\n },\n \"registrationDetails\": {\n \"registrationStatus\": \"\",\n \"Details\": [\n {\n \"PRAN\": \"\",\n \"Amount\": 0,\n \"PoPRegNumber\": \"\",\n \"Transaction ID\": \"\"\n }\n ],\n \"Status\": [\n {\n \"Code\": 0,\n \"Message\": \"\"\n }\n ]\n },\n \"totalRetirementSavings\": \"\"\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\nThis endpoint is used to remove an employee from the corporate database.
\nRequest Body
\nemployerId (string, required): The ID of the employer.
partnerId (string, required): The ID of the partner.
contactNumber (string, required): The contact number of the employee.
Response
The response will indicate the success or failure of the employee removal operation. It returns a JSON object with the following properties:
message (string): A message indicating the result of the operation.
statusCode (integer): A code indicating the status of the operation. A status code of 0 indicates success.
middlewareFor (string): Indicates the middleware context (e.g., corporate).
This endpoint is used to generate a token for a user based on their email and contact number. The token can be utilized for various operations within the application, specifically for corporate purposes.
\nMethod: POST
\nURL: {{awsURL}}/v1/generateToken
The request body must be in JSON format and should include the following parameters:
\nemail (string): The email address of the user requesting the token.
\ncontactNumber (string): The contact number associated with the user.
\ntokenFor (string): A string indicating the purpose for which the token is being generated (e.g., \"corporate\",\"partner\").
\nExample Request Body:
\n{\n \"email\": \"example@example.com\",\n \"contactNumber\": \"1234567890\",\n \"tokenFor\": \"corporate\"\n}\n\nUpon a successful request, the API will return a JSON response with the following structure:
\ndata (object): Contains the result of the token generation.
\ntoken (string): The generated token (will be empty if not generated).
\nemployerId (string): The ID of the employer associated with the token (will be empty if not applicable).
\nmessage (string): A message providing additional context about the request (may be empty).
\nstatusCode (integer): The status code indicating the result of the operation.
\nExample Response:
\n{\n \"data\": {\n \"token\": \"\",\n \"employerId\": \"\"\n },\n \"message\": \"\",\n \"statusCode\": 0\n}\n\nA successful response will have a statusCode of 0, indicating that the token generation was successful.
Ensure that the email and contact number provided are valid to avoid errors in token generation.
\n