v1

latestOpenAPI 3.0.32026-07-26206388.3 KB
Merchant Onboarding

Update Business Details

Submits or updates business information for a merchant. Cannot be updated after T&C is acknowledged by the merchant.

put/gcc/v2/partner/merchant/onboard/{onboardingId}/business-details

Path parameters

onboardingIdstring required

PayGlocal-generated onboarding ID returned by Create Onboarding.

Request body

entityType'INDIVIDUAL' | 'PVT_LTD_COMPANY' | 'PUBLIC_LTD_COMPANY' | 'PROPRIETOR' | 'PARTNERSHIP_FIRM' | 'LLP_FIRM' required

Legal constitution of the business.

gstNumberstring

GST registration number.

natureOfBusinessstring required

Subcategory code from the Get Business Categories API.

tradeNamestring

Trade name or brand name.

iecstring

Importer Exporter Code (preferred for GOODS businesses).

websiteUrlstring required

Merchant website or app store URL.

purposeCodestring required

Primary purpose code for merchant transactions.

Example request

{
  "entityType": "PVT_LTD_COMPANY",
  "gstNumber": "27AAPFU0939F1ZV",
  "natureOfBusiness": "BUS.IT_SERVICES",
  "tradeName": "Acme Payments",
  "websiteUrl": "https://acmepayments.com",
  "purposeCode": "P0802",
  "expectedMonthlyVolume": {
    "amount": "50000",
    "currency": "USD"
  },
  "address": {
    "businessRegisteredAddress": {
      "stateCode": "MH",
      "state": "Maharashtra"
    },
    "businessOperatingAddress": {
      "stateCode": "MH",
      "state": "Maharashtra"
    }
  }
}

Response

Business details updated successfully.

gidstring

PayGlocal global transaction ID.

timestampstring

Response timestamp (DD/MM/YYYY HH:MM:SS).

reasonCodestring

Empty string on success.

Example response

{
  "gid": "gl_9c2645ed09edb22e",
  "timestamp": "10/01/2026 15:00:00",
  "data": {
    "merchantInfo": {
      "onboardingId": "pg_onboard_abc123",
      "partnerOnboardingId": "partner-merchant-001",
      "businessDetails": {
        "businessRegisteredAddress": {
          "stateCode": "MH",
          "state": "Maharashtra"
        },
        "businessOperatingAddress": {
          "stateCode": "MH",
          "state": "Maharashtra"
        }
      }
    }
  }
}