Child Merchant Resource

A ChildMerchant resource represents a new merchant account under a parent merchant. It is used with the Onboarding API to create and onboard new child merchants. To learn how to onboard a new child merchant, check the Onboarding API guide.

📘
The resource attributes are returned based on the feature requirements, check the Retrieve Child Merchant Requirements. Some fields follow specific formatting rules—see the Appendix section of the guide for a summary: Seeds Onboarding Appendix.

A ChildMerchant Resource

{
  "data": {
    "id": "org_xxxxxxxxxxxxxxxxxxxxxxx",
    "type": "merchant",
    "attributes": {
      "activation_status": "pending",
      "bank": {
        "id": "bank_RwCmWfYLN9uz7ohFQD2Np8oV",
        "account_name": "account_name",
        "account_number": "1234567890"
      },
      "business": {
        "address": {
          "line1": "line1",
          "line2": "line2",
          "city": "city",
          "state": "PH-MNL",
          "postal_code": "1234"
        },
        "age": "between_1_and_2_years",
        "customer_service_number": "+6391111111111",
        "date_of_incorporation": {
          "day": 26,
          "month": 4,
          "year": 2024
        },
        "description": "description",
        "dti_registered_name": "Jose Biz",
        "estimated_monthly_volume": "between_500K_and_1M",
        "handle": "josebiz",
        "industry": "automotive",
        "intended_product": "wallets",
        "legal_name": "Jose Biz",
        "physical_store": true,
        "registration_number": "123456",
        "size": "between_10_and_50",
        "tin": "123456000000",
        "trade_name": "Jose Biz",
        "type": "individual",
        "website": "https://www.sample.com"
      },
      "e_wallet": {
        "provider": "gcash",
        "mobile_number": "+639111111111",
        "other_provider": null
      },
      "features": [
        "standard_wallet",
        "payment_gateway"
      ],
      "representative": {
        "address": {
          "line1": "line1",
          "line2": "line2",
          "city": "city",
          "state": "PH-MNL",
          "postal_code": "1234"
        },
        "date_of_birth": {
          "day": 24,
          "month": 5,
          "year": 1994
        },
        "email_address": "[email protected]",
        "first_name": "Jose",
        "last_name": "Rizal",
        "mobile_number": "+639569999999",
        "nationality": "PHL",
        "permanent_address": {
          "line1": "line1",
          "line2": "line2",
          "city": "city",
          "state": "PH-MNL",
          "postal_code": "1234"
        },
        "place_of_birth": {
          "city": "Manila",
          "country": "PH"
        },
        "source_of_funds_other": null,
        "source_of_funds_salary": "Some company",
        "source_of_funds": "salary",
        "tin": "123456000000"
      }
    }
  }
}

id string
A system-generated unique identifier of the resource.

type string
Represents the resource type. Value is always equal to merchant.

accepted_terms_and_conditions boolean
Indicates whether the child merchant has accepted the terms and conditions. In order to start the onboarding process, this should explicitly be stated to true.

activation_status string
The current activation status of the consumer. This field is uneditable but updates automatically when the consumer is submitted for review and after PayMongo completes the account review. Possible values include pending, under_review, activated, and declined.

bank dictionary
Contains bank account details for the child merchant. This includes information such as the ID, account_name, and account_number.

Attribute	Description
id string	Unique ID of the bank account. Refer to the list of available banks.
account_name string	Name associated with the bank account.
account_number string	Bank account number associated with the child merchant. This is a purely numeric value represented as a string.

business dictionary
Contains details about the child merchant's business information.

Attribute	Description
address.line1 string	Line1 of the business address information.
address.line2 string	Line2 of the business address information.
address.city string	City of the business address information.
address.state string	State of the business address information. Refer to the list of available states.
address.postal_code string	Postal code of the business address information.
age string	Age range of the business. Refer to the list of business age.
customer_service_number string	The customer service contact number of the business. This must be a valid phone number formatted as a string, starting with a country code followed by 4 to 15 digits (e.g., +639111111111).
date_of_incorporation.day int	Day of incorporation. The possible values are 1 to 31.
date_of_incorporation.month int	Month of incorporation. The possible values are 1 to 12.
date_of_incorporation.year int	Year of incorporation.
description string	A string that describes the business of the child merchant (max 255 characters).
dti_registered_name string	Registered name of the business with the Department of Trade and Industry (DTI).
estimated_monthly_volume string	Estimated monthly transaction volume range of the business in PHP. The possible values could be found at the list of estimated monthly volume.
handle string	A unique handle or identifier for the business. We require this field to be unique across all our merchants. If left empty, the business handle will be automatically generated based on the trade name.
industry string	Industry or sector in which the business operates. Refer to the list of available industries.
intended_product string	Intended reason for signing up to Paymongo. Refer to the list of intended products.
legal_name string	The legal name of the business. This attribute follows specific rules depending on the business type of the child merchant. For more details, see the Appendix.
physical_store boolean	A boolean value that indicates whether the business has a physical store. This field is required and must be either true or false.
registration_number string	Registration number of the business.
size string	Size of the business in terms of employees. Refer to the list of business sizes.
tin string	Tax Identification Number (TIN) of the business.
trade_name string	Trade name of the business. It must not consist solely of numbers, symbols, or spaces.
type string	Registration type of the business. Possible values are individual, sole_proprietor, partnership, corporation. This attribute follows specific rules depending on the business type of your account. For more details, see the Appendix.
website string	Website URL of the business.

e_wallet dictionary
Contains details about the child merchant's existing e-wallets with other providers.

Attribute	Description
provider string	The provider of the e-wallet. Possible values are `gcash`, `maya`, `grab_pay`, `other`.
other_provider string	Required if provider is set to `other`. Accepts a string value stating an e-wallet provider not included in the list above.
mobile_number string	Mobile number associated with the child merchant's e-wallet. This must be a valid phone number formatted as a string, starting with a country code followed by 4 to 15 digits.

features array of string

List of features available for the child merchant. Possible values are payment_gateway, basic_wallet, standard_wallet. A merchant can have payment_gateway alongside either basic_wallet or standard_wallet, but cannot have more than one wallet type at the same time.

representative dictionary
A dictionary containing the details of the main representative of the child merchant. This includes information such as address, date of birth, contact details, and etc.

Attribute	Description
address.line1 string	Line 1 of the representative address information.
address.line2 string	Line 2 of the representative address information.
address.city string	City of the representative address information.
address.state string	State of the representative address information. Refer to the list of available states.
address.postal_code string	Postal code of the representative address information.
date_of_birth.day int	Day of the representative's date of birth. The possible values are 1 to 31.
date_of_birth.month int	Month of the representative's date of birth. The possible values are 1 to 12.
date_of_birth.year int	Year of the representative's date of birth. The representative must be of legal age.
email_address string	Email address of the representative. This must be a unique email that is not associated with any existing PayMongo account.
first_name string	First name of the representative.
last_name string	Last name of the representative.
mobile_number string	Mobile number of the representative. This must be a valid phone number formatted as a string, starting with a country code followed by 4 to 15 digits (e.g., +639111111111).
nationality string	Nationality of the representative. This is represented by a 3-letter ISO code (e.g., PHL for the Philippines). Refer to the list of nationalities.
nature_of_work string	Nature of work of the representative. Refer to the list for the possible values for nature of work.
permanent_address.line1 string	Line 1 of the representative permanent address information.
permanent_address.line2 string	Line2 of the representative permanent address information.
permanent_address.city string	City of the representative permanent address information.
permanent_address.state string	State of the representative permanent address information. Refer to the list of available states.
permanent_address.postal_code string	Postal code of the representative permanent address information.
place_of_birth.city string	City of the representative's place of birth.
place_of_birth.country string	Country of birth, represented by an ISO 3166-1 alpha-2 code (e.g., PH for the Philippines).
source_of_funds string	Source of funds of the representative. Possible values are `salary`, `pension`, `allowance`, `commission`, `donation`, and `other`
source_of_funds_other string	Required if source_of_funds is set to `other`. Accepts a string value stating the source_of_funds not included in the list above.
source_of_funds_salary string	Required if source_of_funds is set to `salary`. Accepts a string value stating the nature of the representative's line of work.
tin string	Tax Identification Number (TIN) of the representative.

terms_and_conditions_consented_at timestamp
The date when the ChildMerchant has agreed to the terms and conditions.

created_at timestamp
The date when the ChildMerchant has been created.

updated_at timestamp
The date when the ChildMerchant has been updated.