iPintiPint Docs
Aggregator / PSP

Onboard Merchant

Onboard a merchant as an aggregator using POST /aggregator/merchants.

POST /aggregator/merchants

POST/aggregator/merchants

Onboard a merchant under your aggregator account. Requires the merchant's full business details, KYC confirmations, and fee structure.

Headers

HeaderRequiredDescription
content-typeYesapplication/json
apikeyYesYour API key
signatureYesHMAC-SHA384 signature
nonceYesCurrent Unix timestamp

Request body

All details are of the merchant's business.

{
  "legal_name_of_business": "Legal Name of Merchant Business",
  "business_registration_country": "Name of Country",
  "legal_status_of_business": "Sole Trader",
  "business_type": "B2B",
  "industry": "Financial Services",
  "annual_revenue": "$ 0-1 Million",
  "trade_name_of_service": "Trade Name",
  "business_registration_number": "Business Registration Number",
  "main_business_activity": "Main Activity of Business",
  "target_website": "Website where API to be used",
  "date_of_incorporation": "2020-01-15",
  "expected_maximum_amount_single_transaction": "10000",
  "expected_yearly_transaction_volume": "10000000",
  "merchant_tool": "API",
  "legally_registered_business_address": {
    "house_number": "23",
    "street_name1": "near saw mill",
    "street_name2": "Lotus Vihar",
    "city": "Philadelphia",
    "state": "Pennsylvania",
    "postal_code": "19092"
  },
  "contact": {
    "phone_number": "79832689342",
    "country_phone_code": "+1",
    "website": "abc.co",
    "support_email": "support@abc.co",
    "notification_email": "support@abc.co"
  },
  "business_beneficial_owner": {
    "first_name": "First Name",
    "last_name": "Last Name",
    "date_of_birth": "1985-05-20",
    "relation_with_organization": "Managing Director/CEO",
    "email": "benef@email.com",
    "country_phone_code": "+91",
    "phone_number": "7835211996"
  },
  "merchant_fee": "2.5",
  "is_merchant_kyc_done_by_psp": "YES",
  "can_psp_share_merchant_data_with_ipint": "YES",
  "is_merchant_agreed_with_ipint_policies": "YES"
}

Field reference

Business details

FieldOptionsDescription
legal_status_of_businessSole Trader, Partnership, Incorporated Company, Government Organization, Non-ProfitLegal structure
business_typeB2B, B2C, BothBusiness type
annual_revenue$ 0-1 Million, $ 1-25 Million, $ 25-100 Million, $ More than 100 MillionRevenue range
industrySee /industriesIndustry category
date_of_incorporationYYYY-MM-DDDate format

Beneficial owner

FieldOptionsDescription
relation_with_organizationManaging Director/CEO, Director, Promoter, Principal, OtherRole
other_relationshipstringRequired if relation_with_organization is Other

Confirmations

FieldRequired valueDescription
is_merchant_kyc_done_by_pspYESPSP confirms KYC/AML check done
can_psp_share_merchant_data_with_ipintYESMerchant agrees to share KYC with iPint
is_merchant_agreed_with_ipint_policiesYESMerchant agrees to iPint's Terms, Privacy, AML/CFT policies

Success response (200)

{ "message": "OK", "merchant_id": "Merchant ID" }

Error response (400)

{ "error": true, "message": "description for error" }

Next steps

On this page