Customer Signup Request

Implement this API to onboard an Customer to the Pay2New platform. Pay2New will update the outlet profile if it's already registered.

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

Start customer onboarding and request the signup OTP.

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

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.
aadhaar_numberYesAadhaar number. Send the plain 12-digit value when using this field. Must be greater than 0.
emailYesEmail.
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.
account_numberYesAccount number.
ifscYesDestination bank IFSC.
request_idYesYour reference for this request. At least 8 characters.

Usage notes

  • Use product 291 for onboarding; product_code is optional on this request.
  • Keep the returned order_id, data.otpReferenceID and data.hash for Signup OTP Validate.

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",
  "aadhaar_number": "999999999999",
  "email": "[email protected]",
  "latitude": "18.5204",
  "longitude": "73.8567",
  "terms_agree": "Y",
  "ip": "192.0.2.10",
  "account_number": "000000000001",
  "ifsc": "ABCD0123456",
  "request_id": "EXAMPLE202609260001"
}

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
dataprovider response object containing otpReferenceID and hash when provided

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",
  "data": {
    "otpReferenceID": "EXAMPLE_OTP_REFERENCE",
    "hash": "EXAMPLE_HASH"
  }
}

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

Aadhaar number. Send the plain 12-digit value when using this field. Must be greater than 0.

string
required

Email.

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

Account number.

string
required

Destination bank IFSC.

string
required

Your reference for this request. At least 8 characters.

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