Consumer Resource

A Consumer resource represents a consumer account linked to a parent merchant. It is used with the Onboarding API to create and onboard new merchant related consumers. To learn how to onboard a new consumer, check the Onboarding API guide.

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

A Consumer Resource

{
    "data": {
        "id": "org_xxxxxxxxxxxxxxxxxxxxxxx",
        "type": "consumer",
        "attributes": {
            "activation_status": "pending",
            "address": {
                "line1": "Line1",
                "line2": "Line2",
                "city": "City",
                "postal_code": "1234",
                "state": "PH-MNL"
            },
            "date_of_birth": {
                "day": 1,
                "month": 1,
                "year": 2000
            },
            "email_address": "[email protected]",
            "features": [
                "fully_verified_standard_wallet"
            ],
            "first_name": "Jose",
            "intended_use": "store_value",
            "last_name": "Rizal",
            "mobile_number": "+639569999999",
            "nationality": "PHL",
            "nature_of_work": "employed_locally",
            "onboarding_url": "https://seeds-onboarding.paymongo.com/onboarding/consumers/org_xxxx",
            "permanent_address": {
                "line1": "Line1111",
                "line2": "Line2",
                "city": "City",
                "state": "PH-MNL",
                "postal_code": "1234"
            },
            "place_of_birth": {
                "city": "PH-MNL",
                "country": "PH"
            },
            "source_of_funds": "salary",
            "source_of_funds_other": null,
            "source_of_funds_salary": "My company",
            "tin": "123456000000",
            "created_at": 1724900813,
            "terms_and_conditions_consented_at": 1724900813,
            "updated_at": 1724900819
        }
    }
}

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

type string
Represents the resource type. Value is always consumer.

accepted_terms_and_conditions boolean
Indicates whether the consumer 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.

address object
Current address details of the consumer

Attribute	Description
line1 string	First line of the consumer's current address
line2 string	Second line of the consumer's current address
city string	City of the consumer’s current address.
postal_code string	Postal code of the consumer’s current address.
state string	State of the consumer's current address. Refer to the list of available states .

date_of_birth object
Date of the consumer’s date of birth.

Attribute	Description
day integer	Day of the consumer’s date of birth. The possible values are 1 to 31.
month integer	Month of the consumer’s date of birth. The possible values are 1 to 12.
year integer	Year of the consumer’s date of birth. The representative must be of legal age.

email_address string
Email address of the consumer.

features array of string

List of features available for the child merchant. Possible values are basic_wallet,fully_verified_standard_wallet. Only one wallet feature is allowed.

first_name string
First name of the consumer

intended_use string
The intended use for the consumer account. The possible values are bills_payment, fund_transfer, and store_value

last_name string
Last name of the consumer

mobile_number string
Mobile contact number of the consumer

nationality string
Nationality of the consumer. 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.

onboarding_url string
A string containing the URL for the PayMongo hosted onboarding link.

permanent_address object
Permanent address of the consumer.

Attribute	Description
line1 string	First line of the consumer's permanent address
line2 string	Second line of the consumer's permanent address
city string	City of the consumer's permanent address
postal_code string	Postal code of the consumer's permanent address
state string	State of the consumer's permanent address. Refer to the list of available states .

place_of_birth dictionary
Contains details about the consumer's existing e-wallets with other providers.

Attribute	Description
city string	The name of the city.
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 consumer. 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 options of source_of_funds.

source_of_funds_salary string
Required if source_of_funds is set to salary. Accepts a string value stating the nature of the consumer’s line of work.

tin string
Tax Identification Number of the consumer.

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

created_at timestamp
The date when the consumer has been created.

updated_at timestamp
The date when the consumer has been updated.