PAN-Based Onboarding API

This API is used to onboard a customer using PAN-based details. No OTP validation step is required for this PAN-based onboarding flow.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Onboard a customer using PAN and the required customer profile.

POST https://pay2new.in/apis/v1/onboard/customerMinKyc

Headers

HeaderRequiredDescription
secretYesYour Pay2New API secret.
Content-TypeYesapplication/json
AcceptNoRequest a JSON response.

Requests require an active partner account, approved KYC, active wallet and API access, an allowlisted source IP, and the relevant service enabled.

JSON request

FieldRequiredDescription
mobile_numberYesMobile number. Exactly 10 characters. Digits only.
pan_numberYesPan number. Exactly 10 characters.
nameYesName.
genderYesGender. Allowed value(s): M,F,O.
aadhaar_numberOne of these twoAadhaar number. Send the plain 12-digit value when using this field. Exactly 12 characters. Digits only.
aadhaarOne of these twoEncrypted Aadhaar value accepted as an alternative to aadhaar_number.
emailYesEmail.
addressYesAddress.
cityNoCity.
pincodeYesPincode. Exactly 6 characters. Digits only.
dobYesDob. Format YYYY-MM-DD.
latitudeYesLatitude as a decimal value. Accepted as a JSON number or decimal string.
longitudeYesLongitude as a decimal value. Accepted as a JSON number or decimal string.
terms_agreeYesCustomer consent. Send Y only after receiving consent. Allowed value(s): Y.
product_codeNoProduct code enabled for your partner account. Retrieve it from the product list. Digits only.
ipYesIPv4 address of the customer-facing endpoint.
request_idYesYour reference for this request. At least 8 characters.
stateNoOptional profile information.
districtNoOptional profile information.
photoNoOptional profile information.

Usage notes

  • Provide aadhaar_number (12 digits) or aadhaar (encrypted value). At least one is required; aadhaar takes precedence if both are supplied.
  • Product 291 is used for this onboarding flow; product_code is optional.
  • On success, store the returned Pay2New outletId for later outlet-based requests.

Request example

All identities and account values below are synthetic. Replace placeholders, including the enabled product code and fresh device capture, before sending a request.

{
  "mobile_number": "9000000001",
  "pan_number": "ABCDE1234F",
  "name": "Example Merchant",
  "gender": "M",
  "email": "[email protected]",
  "address": "Example Address",
  "pincode": "411001",
  "dob": "1990-01-01",
  "latitude": "18.5204",
  "longitude": "73.8567",
  "terms_agree": "Y",
  "ip": "192.0.2.10",
  "request_id": "EXAMPLE202609260001",
  "aadhaar_number": "999999999999"
}

Response

Application status is returned in the JSON status field. A successful HTTP response alone does not confirm a successful operation.

FieldDescription
statusinteger: application status, not HTTP status
messagestring
order_idstring
request_idstring
outletIdPay2New customer ID, success only
dataObject with name, address, gender, pincode, dob, state, district, photo, pan_number.

Provider-dependent fields may be absent or null. status: 2 indicates a failure. For transaction endpoints, status: 3 indicates pending or uncertain processing and requires status confirmation.

Illustrative response:

{
  "status": 1,
  "message": "Success",
  "order_id": "EXAMPLE_ORDER_001",
  "request_id": "EXAMPLE202609260001",
  "outletId": "123",
  "data": {
    "name": "Example Merchant",
    "address": "Example Address",
    "gender": "M",
    "pincode": "411001",
    "dob": "1990-01-01",
    "state": "Maharashtra",
    "district": "Pune",
    "photo": null,
    "pan_number": "ABCDE1234F"
  }
}

Errors

Validation errors can include an errors object keyed by field name. Authentication, outlet, service and other processing errors can return only status and message. Errors are application-level responses; do not rely on an HTTP 400 status.

{
  "status": 2,
  "message": "Invalid Parameters",
  "errors": {
    "mobile_number": "Provide a valid value for this field."
  }
}
Body Params
string
required

Mobile number. Exactly 10 characters. Digits only.

string
required

Pan number. Exactly 10 characters.

string
required

Name.

string
required

Gender. Allowed value(s): M,F,O.

string

Aadhaar number. Send the plain 12-digit value when using this field. Exactly 12 characters. Digits only.

string

Encrypted Aadhaar value accepted as an alternative to aadhaar_number.

string
required

Email.

string
required

Address.

string

City.

string
required

Pincode. Exactly 6 characters. Digits only.

string
required

Dob. Format YYYY-MM-DD.

string
required

Latitude as a decimal value. Accepted as a JSON number or decimal string.

string
required

Longitude as a decimal value. Accepted as a JSON number or decimal string.

string
required

Customer consent. Send Y only after receiving consent. Allowed value(s): Y.

string

Product code enabled for your partner account. Retrieve it from the product list. Digits only.

string
required

IPv4 address of the customer-facing endpoint.

string
required

Your reference for this request. At least 8 characters.

string

Optional profile information.

string

Optional profile information.

string

Optional profile information.

Headers
string
required

Your Pay2New API secret.

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json