v1

latestOpenAPI 3.1.02026-07-24360204.4 KB

Sub Account Onboarding API

Use this API to create the subaccount

post/pg_settlements/sub_accounts

Request body

recepient_namestring required

Name of the sub-account

email_idstring required

Email address of the sub-account

mobile_numberstring required

Mobile number of the sub-account

bene_account_numberstring required

Account Number of the sub-account

ifsc_codestring required

IFSC code for the account

branch_namestring required

Branch name corresponding to the IFSC provided

bank_namestring required

Bank name of the sub-account's account number

Response

200

statusinteger

Example response

{
  "data": [
    {
      "sub_accounts_id": "sa_da4f9f84ac6d",
      "recepient_name": "John Doe",
      "email_id": "john.doe@gmail.co",
      "mobile_number": "7558042380",
      "bene_account_number": "8912067067",
      "ifsc_code": "KKBK0008072",
      "bank_name": "KOTAK MAHINDRA BANK",
      "branch_name": "KOTAK MAHINDRA BANK",
      "status": "pending"
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 15,
      "current_page": 1,
      "total_pages": 1
    }
  },
  "status": 200
}