The Account resource represents an account entity. It holds all the necessary details and statuses for an account entity. To learn how to onboard a new child account, check the Onboarding API guide.
Some fields follow specific formatting rules—see the Appendix section of the guide for a summary: Onboarding Appendix.
Account Resource
Merchant type
{
"data": {
"id": "org_zeZdrgooHpjxzDpwvAsHXEAr",
"type": "merchant",
"activation_status": "activated",
"person": {
"type": "representative",
"first_name": "Juan",
"last_name": "Dela Cruz",
"middle_name": "Clara",
"mobile_number": "+639569999999",
"email_address": "[email protected]",
"date_of_birth": {
"day": 1,
"month": 1,
"year": 1990
},
"nationality": "PHL",
"nature_of_work": "self_employed",
"place_of_birth": {
"city": "Manila",
"country": "PH"
},
"source_of_funds": "other",
"source_of_funds_other": "ABC Corporation",
"source_of_funds_salary": null,
"tin": "123-456-789",
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Makati",
"state": "PH-MNL",
"country": "PH",
"postal_code": "1234"
},
"permanent_address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Makati",
"state": "PH-MNL",
"country": "PH",
"postal_code": "1234"
},
"identity_verification_status": "passed"
},
"bank": {
"id": "bank_Sp1S7fyFfk6ACKFc3RCWeEkH",
"account_name": "Juan Dela Cruz",
"account_number": "123456789012",
"bank_name": "BDO Unibank"
},
"business": {
"address": {
"line1": "456 Business Ave",
"line2": "Floor 10",
"city": "Makati",
"state": "PH-MNL",
"country": "PH",
"postal_code": "1234"
},
"age": "between_1_and_2_years",
"customer_service_number": "+639171234567",
"date_of_incorporation": {
"day": 15,
"month": 6,
"year": 2020
},
"description": "E-commerce store selling electronics",
"dti_registered_name": "ABC Trading",
"estimated_monthly_volume": "between_100K_and_300K",
"handle": "abc-store",
"industry": "5732",
"legal_name": "ABC Corporation",
"physical_store": true,
"registration_number": "DTI-123456",
"size": "less_than_10",
"tin": "123-456-789-000",
"trade_name": "ABC Store",
"type": "corporation",
"website": "https://example.com"
},
"created_at": 1680000000,
"updated_at": 1680002000
}
}Consumer type
{
"data": {
"id": "org_zeZdrgooHpjxzDpwvAsHXEAr",
"type": "consumer",
"activation_status": "activated",
"person": {
"type": "representative",
"first_name": "Juan",
"last_name": "Dela Cruz",
"middle_name": "Clara",
"mobile_number": "+639569999999",
"email_address": "[email protected]",
"date_of_birth": {
"day": 1,
"month": 1,
"year": 1990
},
"nationality": "PHL",
"nature_of_work": "employed_locally",
"place_of_birth": {
"city": "Manila",
"country": "PH"
},
"source_of_funds": "salary",
"source_of_funds_other": null,
"source_of_funds_salary": "PayMongo Inc.",
"tin": "123-456-789",
"address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Makati",
"state": "PH-MNL",
"country": "PH",
"postal_code": "1234"
},
"permanent_address": {
"line1": "123 Main St",
"line2": "Apt 4B",
"city": "Makati",
"state": "PH-MNL",
"country": "PH",
"postal_code": "1234"
},
"identity_verification_status": "passed"
},
"created_at": 1680000000,
"updated_at": 1680002000
}
}id string
A system-generated unique identifier for the account. Prefixed with org_.
type string
The type of account. Either consumer or merchant.
activation_status string
The current activation status of the account. Can be pending, under_review, activated, or declined.
person object
Contains information about the account owner (for consumer accounts) or authorized representative (for merchant accounts).
person.type string
The person's relationship to the account. Always representative for both consumer and merchant accounts.
person.first_name string
The person's first name.
person.last_name string
The person's last name.
person.middle_name string | null
The person's middle name. Optional.
person.mobile_number string
The person's mobile phone number. Required.
person.email_address string
The person's email address. Required.
person.date_of_birth object
The person's date of birth represented as an object with day, month, and year properties.
day: Day of the person's date of birth. The possible values are 1 to 31month: Month of the person's date of birth. The possible values are 1 to 12
person.nationality string | null
The person's nationality as an ISO 3166-1 alpha-3 country code (e.g., PHL for Filipino).
person.nature_of_work string | null
The person's nature of work. Valid values: employed_locally, retired, pensioner, ofw, ofw_beneficiary, student, self_employed, unemployed_spouse_income, unemployed_other_income.
person.place_of_birth object
The person's place of birth with city and country properties.
city: City of birth. Accepts a stringcountry: Country of birth, represented by an ISO 3166-1 alpha-2 code (e.g., PH for the Philippines).
person.source_of_funds string | null
The person's primary source of funds. Valid values: salary, pension, allowance, commission, donation, other.
person.source_of_funds_other string | null
Required if source_of_funds is set to other. Accepts a string value stating of business name
person.source_of_funds_salary string | null
Required if source_of_funds is set to salary. Accepts a string value of company name
person.tin string | null
The person's Tax Identification Number.
person.address object
The person's current residential address with properties: line1, line2, city, state, country, and postal_code.
person.permanent_address object | null
The person's permanent address. Same structure as address. Optional.
person.identity_verification_status string
The status of the person's identity verification. Can be pending, processing, for_review, passed, passed_attestation_form, or failed.
bank object | null
Bank account information. Only present in the response for merchant accounts when at least one bank field has been populated. Omitted entirely from the response for consumer accounts.
bank.id string
A system-generated unique identifier for the bank record. Prefixed with bank_.
bank.account_name string
The name of the bank account holder.
bank.account_number string
The bank account number.
bank.bank_name string
The name of the bank.
business object | null
Business information. Only populated for merchant accounts; null for consumer accounts.
business.address object
The business address with properties: line1, line2, city, state, country, and postal_code.
business.age string | null
The age of the business. Valid values: less_than_1_year, between_1_and_2_years, between_2_and_5_years, and greater_than_5_years
business.customer_service_number string | null
The business customer service contact number.
business.date_of_incorporation object
The date the business was incorporated, represented as an object with day, month, and year properties.
business.description string | null
A brief description of the business.
business.dti_registered_name string | null
The business name as registered with the Department of Trade and Industry (DTI).
business.estimated_monthly_volume string | null
The estimated monthly transaction volume. Valid values: less_than_100K, between_100K_and_300K, between_300K_and_500K, between_500K_and_1M, between_1M_and_3M, greater_than_3M.
business.handle string | null
A unique handle or slug for the business.
business.industry string | null
The business industry category as a Merchant Category Code (MCC). Accepts a 4-digit numeric string (e.g., "5732" for Electronics Stores, "5411" for Grocery Stores, "7011" for Hotels)
business.legal_name string | null
The legal name of the business entity.
business.physical_store boolean | null
Indicates whether the business has a physical store location.
business.registration_number string | null
The business registration number (e.g., DTI, SEC number).
business.size string | null
The size of the business by number of employees. Valid values: less_than_10, between_10_and_50, between_51_and_250, greater_than_250.
business.tin string | null
The business Tax Identification Number.
business.trade_name string | null
The trade name or doing-business-as (DBA) name.
business.type string | null
The business entity type. Valid values: individual, sole_proprietor, partnership, corporation.
business.website string | null
The business website URL.
created_at integer
Unix timestamp indicating when the account was created.
updated_at integer
Unix timestamp indicating when the account was last updated.