Settlement Add Account

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

Verify and register a settlement account for the outlet.

POST https://pay2new.in/apis/aeps/v1/addAccount

Headers

HeaderRequiredDescription
secretYesYour Pay2New API secret.
outletIdYesPay2New outlet/customer ID returned after successful onboarding; do not send the provider outlet ID.
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
bankYesBank.
account_holder_nameYesAccount holder name.
account_numberYesAccount number.
ifscYesDestination bank IFSC.
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.
request_idYesYour reference for this request. At least 8 characters.
ipYesIPv4 address of the customer-facing endpoint.

Usage notes

  • Registration requires an available settlement-account slot, successful account verification, a matching onboarded customer name, and successful provider linking.
  • Check status, instantpay_status and is_verified for registration success. txn_status describes the verification transaction and may differ from the final registration status.

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.

{
  "bank": "Example Bank",
  "account_holder_name": "Example Merchant",
  "account_number": "000000000001",
  "ifsc": "ABCD0123456",
  "latitude": "18.5204",
  "longitude": "73.8567",
  "terms_agree": "Y",
  "request_id": "EXAMPLE202609260001",
  "ip": "192.0.2.10"
}

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
txn_statusinteger: verification transaction status
operator_referencestring or null, when supplied
bene_namestring or null, when supplied
instantpay_statusadded, failed, or pending; when linking attempted
is_verifiedinteger 0 or 1; when linking attempted

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",
  "txn_status": 1,
  "operator_reference": "EXAMPLE_REFERENCE",
  "bene_name": "Example Merchant",
  "instantpay_status": "added",
  "is_verified": 1
}

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": {
    "bank": "Provide a valid value for this field."
  }
}
Body Params
string
required

Bank.

string
required

Account holder name.

string
required

Account number.

string
required

Destination bank IFSC.

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
required

Your reference for this request. At least 8 characters.

string
required

IPv4 address of the customer-facing endpoint.

Headers
string
required

Your Pay2New API secret.

string
required

Pay2New outlet/customer ID returned after successful onboarding; do not send the provider outlet ID.

Response

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