Overview
This page lists all valid enumeration values accepted by the Onboarding API. Use these exact string values when submitting merchant onboarding requests.All enum values are case-sensitive. Make sure to use the exact capitalization shown below.
Business Type
Determines the type of business entity and affects which fields are required during onboarding.| Value | Description | Incorporators Required | Legal Name Required |
|---|---|---|---|
STARTER | Starter Business | No | No |
SOLE_PROPRIETOR | Sole Proprietor | 1 | Yes |
PARTNERSHIP | Partnership | 2 | Yes |
CORPORATION | Corporation | Minimum 3 | Yes |
Usage Example
STARTER
STARTER
Best for: Small businesses, sole traders, freelancersRequirements:
- Barangay Business Permit
- No incorporators needed
- No registered address needed
- Legal name optional
SOLE_PROPRIETOR
SOLE_PROPRIETOR
Best for: Individual business ownersRequirements:
- 1 incorporator required
- Legal name required
- Registered address required
- Additional KYC documents
PARTNERSHIP
PARTNERSHIP
Best for: Business partnerships, joint venturesRequirements:
- 2 incorporators required
- Legal name required
- Registered address required
- Partnership agreement documents
CORPORATION
CORPORATION
Best for: Registered corporationsRequirements:
- Minimum 3 incorporators required
- Legal name required
- Registered address required
- Corporate registration documents
Mode of Payment
Specifies which payment channels the merchant wants to enable.| Value | Description | Use Case |
|---|---|---|
TERMINAL | Physical POS terminals | In-store retail |
ECOM | E-commerce integration | Online checkout |
PAYMENT_LINK | Shareable payment URLs | Invoices, remote sales |
QRPH | QR Ph standard | Contactless payments |
PAY_WITH_MAYA | Maya wallet | E-wallet transactions |
Usage Example
Currency
Three-letter ISO 4217 currency codes for customer transactions.| Value | Description |
|---|---|
PHP | Philippine Peso |
USD | United States Dollar |
Usage Example
Currently, only
PHP and USD are supported. The default currency is PHP.Bank Names
All supported banks for settlement accounts. Use these exact values for thebankName field.
- Major Banks (A-M)
- Major Banks (P-Z)
- E-Wallets
| Value | Bank Name |
|---|---|
AGRIBUSINESS_RURAL_BANK_INC | Agribusiness Rural Bank |
AL_AMANAH_ISLAMIC_BANK | Al Amanah Islamic Bank |
ALIPAY_PHILIPPINES_INC | Alipay Philippines |
ALLBANK_INC | AllBank |
ANZ_BANK | ANZ Bank |
ASIA_UNITED_BANK | Asia United Bank |
BANANAPAY_FINTECH_SERVICES_CORPORATION | Bananapay |
BANGKO_KABAYAN | Bangko Kabayan |
BANGKO_MABUHAY_A_RURAL_BANK_INC | Bangko Mabuhay |
BANGKO_NUESTRA_SENORA_DEL_PILAR | Bangko Nuestra Senora del Pilar |
BANGKOK_BANK | Bangkok Bank |
BANK_OF_AMERICA_NA | Bank of America |
BANK_OF_CHINA_MANILA | Bank of China |
BANK_OF_COMMERCE | Bank of Commerce |
BANK_OF_FLORIDA | Bank of Florida |
BANK_OF_MAKATI | Bank of Makati |
BANK_OF_THE_PHILIPPINE_ISLANDS_BPI | BPI |
BAYANIHAN_BANK_INC_ATIMONAN | Bayanihan Bank |
BDO_NETWORK_BANK | BDO Network Bank |
BDO_UNIBANK | BDO Unibank |
BINAN_RURAL_BANK_INC | Binan Rural Bank |
BPI_DIRECT_BANKO_INC_A_SAVINGS_BANK | BPI Direct Banko |
CAMALIG_BANK_INC_A_RURAL_BANK | Camalig Bank |
CANTILAN_BANK_INC | Cantilan Bank |
CARD_BANK_INC | Card Bank |
CARD_MRI_RIZAL_BANK_INC | Card MRI Rizal Bank |
CARD_SME_BANK_INC_A_THRIFT_BANK | Card SME Bank |
CATHAY_UNITED_BANK_CO_LTD | Cathay United Bank |
CEBUANA_LHUILLIER_RURAL_BANK_INC | Cebuana Lhuillier Rural Bank |
CHINA_BANK | China Banking Corporation |
CHINA_BANK_SAVINGS | China Bank Savings |
CIMB | CIMB Bank Philippines |
CIS_BAYAD_CENTER_INC_CBCI | CIS Bayad Center |
CITIBANK_NA | Citibank |
CITY_SAVINGS_BANK | City Savings Bank |
COOPERATIVE_BANK_OF_QUEZON_PROVINCE | Cooperative Bank of Quezon Province |
COUNTRY_BUILDERS_BANKING | Country Builders Bank |
CTBC_BANK | CTBC Bank |
DCPAY_PHILIPPINES_INC_COINSPH | DCPay Philippines |
DEUTSCHE_BANK | Deutsche Bank |
DEVELOPMENT_BANK_OF_THE_PHILIPPINES_DBP | Development Bank of the Philippines |
DM_BANK | DM Bank |
DUMAGUETE_CITY_DEVELOPMENT_BANK_INC | Dumaguete City Development Bank |
DUNGGANUN_BANK | Dungganun Bank |
EAST_WEST_RURAL_BANK_INC | East West Rural Bank |
EASTWEST_BANK | EastWest Bank |
EASY_PAY_GLOBAL_EMI_CORP | Easy Pay Global |
ENTREPRENEUR_RURAL_BANK_INC | Entrepreneur Rural Bank |
EQUICOM_SAVINGS_BANK | Equicom Savings Bank |
FIRST_CONSOLIDATED_BANK | First Consolidated Bank |
GCASH | G-Xchange |
GM_BANK_OF_LUZON_INC | GM Bank of Luzon |
GOTYME | GoTyme Bank |
GRABPAY | GrabPay |
GUAGUA_RURAL_BANK_INC | Guagua Rural Bank |
HONG_KONG_AND_SHANGHAI_BANK_HSBC | HSBC |
HSBC_SAVINGS_BANK_PHILSINC | HSBC Savings Bank |
INDUSTRIAL_BANK_OF_KOREA_MANILA | Industrial Bank of Korea |
INDUSTRIAL_COMMERCIAL_BANK_OF_CHINA | ICBC |
INFOSERVE_INCORPORATED_NATIONLINK | Infoserve |
ING_BANK | ING Bank |
INNOVATIVE_BANK | Innovative Bank |
I-REMIT_INC | I-Remit |
ISLA_BANK_A_THRIFT_BANK_INC | ISLA Bank |
JP_MORGAN_CHASE_BANK_MANILA | JP Morgan Chase Bank |
KOREA_EXCHANGE_BANK | KEB Hana Bank |
LAGUNA_PRESTIGE_BANKING_CORPORATION | Laguna Prestige Banking Corp |
LAND_BANK_OF_THE_PHILIPPINES | Land Bank of the Philippines |
LEGAZPI_SAVINGS_BANK_INC | Legazpi Savings Bank |
LOLC_BANK_PHILIPPINES_INC | LOLC Bank |
LULU_FINANCIAL_SERVICES_PHILS_INC | Lulu Financial Services |
LUZON_DEVELOPMENT_BANK | Luzon Development Bank |
MALARAYAT_RURAL_BANK_INC | Malarayat Rural Bank |
MALAYAN_BANK_SAVINGS_AND_MORTGAGE_BANK_INC | Malayan Bank |
MARCOPAY_INC | Marcopay |
MAYA_BANK | Maya Bank |
MAYBANK_PHILIPPINES | Maybank Philippines |
MEGA_INTERNATIONAL_COMMERCIAL_BANK | ICBC |
METROPOLITAN_BANK_TRUST_CO_METROBANK | Metrobank |
MINDANAO_CONSOLIDATED_COOPERATIVE_BANK | Mindanao Consolidated Coop Bank |
MIZUHO_BANK | Mizuho Bank |
MONEY_MALL_RURAL_BANK_INC | Money Mall Rural Bank |
MUFG_BANK | MUFG Bank |
MVSM_BANK_A_RURAL_BANK_INC | MVSM Bank |
NETBANK_A_RURAL_BANK_INC | Netbank |
NEW_RURAL_BANK_OF_SAN_LEONARDO_NUEVA_ECIJA_INC | New Rural Bank of San Leonardo |
OMNIPAY_INC | Omnipay |
OWN_BANK_THE_RURAL_BANK_OF_CAVITE_CITY_INC | Own Bank |
Usage Example
Bank Account Type
Account type for traditional bank accounts.| Value | Description |
|---|---|
SAVINGS | Savings Account |
CHECKING_CURRENT | Checking/Current Account |
Usage Example
This field is required only when
accountDepositType is "BANK".Bank Account Deposit Type
Specifies the type of settlement account.| Value | Description | When to Use |
|---|---|---|
BANK | Traditional bank account | For standard bank settlements |
GCASH | GCash e-wallet | For GCash settlements |
PAYMAYA | PayMaya e-wallet | For PayMaya settlements |
NO_ACCOUNT | No settlement account | Special cases only |
Usage Examples
BANK - Traditional Bank Account
BANK - Traditional Bank Account
Required fields:
accountType(SAVINGS or CHECKING_CURRENT)bankName(from supported banks list)accountNameaccountNumbercurrency
GCASH - E-wallet
GCASH - E-wallet
Required fields:
bankName(must be “GCASH”)accountNameaccountNumber(GCash mobile number)
PAYMAYA - E-wallet
PAYMAYA - E-wallet
Required fields:
bankName(must be “PAYMAYA”)accountNameaccountNumber(PayMaya mobile number)
NO_ACCOUNT
NO_ACCOUNT
Use for: Special cases where no settlement account is needed
Source of Funds
Indicates the source of funds for incorporators.| Value | Description |
|---|---|
EMPLOYMENT_INCOME | Employment Income |
BUSINESS_INCOME | Business Income |
SAVINGS_PERSONAL_FUNDS | Savings/Personal Funds |
INVESTMENT_INCOME | Investment Income |
INHERITANCE_OR_GIFTS | Inheritance or Gifts |
LOAN_PROCEEDS | Loan Proceeds |
OTHERS | Others |
Usage Example
Gender
Gender options for incorporators and representatives.| Value | Description |
|---|---|
MALE | Male gender |
FEMALE | Female gender |
Usage Example
Onboarding Status
Lifecycle states for merchant onboarding applications.| Value | Description | Next Possible States |
|---|---|---|
NEW | Initial submission, awaiting approval | APPROVED, DECLINED |
APPROVED | Merchant approved | DECLINED (if issues found) |
DECLINED | Merchant declined | PENDING (after update) |
PENDING | Resubmitted after decline, awaiting re-approval | APPROVED, DECLINED |
Status Flow
NEW
NEW
When: Initial merchant onboarding submissionMerchant Action: Wait for Modulus Labs reviewNext Steps: Status will change to either APPROVED or DECLINED
APPROVED
APPROVED
When: Merchant passes KYC verificationMerchant Action: Can start accepting paymentsNote: Approved merchants can be declined later if compliance issues are discovered
DECLINED
DECLINED
When: Merchant fails KYC verification or documents are incompleteMerchant Action: Review decline reason, update information, and resubmitNext Steps: Resubmitting will change status to PENDING
PENDING
PENDING
When: Merchant has updated information after being declinedMerchant Action: Wait for re-review by Modulus LabsNext Steps: Status will change to either APPROVED or DECLINED
Validation Quick Reference
Use this table for quick validation during implementation:| Field | Type | Format | Notes |
|---|---|---|---|
businessType | Enum | String | Use exact enum value |
legalName | String | 1-500 chars | Required for non-STARTER |
merchantName | String | 1-500 chars | Always required |
tin | String | 9-12 digits | Numbers only |
currency | Enum | 3 chars | Usually “PHP” |
industry | String | 1-200 chars | Brief description |
contactNumber | String | 1-30 digits | Numbers only |
postalCode | String | 4-10 digits | Numbers only |
emailAddress | String | 1-100 chars | Valid email format |
dateOfBirth | String | ISO 8601 | YYYY-MM-DDTHH:mm:ss.sssZ |
Common Mistakes
Wrong Capitalization
Wrong Capitalization
Wrong:
"businessType": "starter" or "GCASH" as bankName for bank typeCorrect: "businessType": "STARTER" and proper account deposit typeSolution: Always use uppercase for enum valuesInvalid Bank for Deposit Type
Invalid Bank for Deposit Type
Wrong:Correct:Solution: Match bankName with accountDepositType
Missing Required Fields for Business Type
Missing Required Fields for Business Type
Wrong: CORPORATION with only 1 incorporatorCorrect: CORPORATION with at least 3 incorporatorsSolution: Check business type requirements in the table above
Invalid Enum Value
Invalid Enum Value
Wrong:
"modeOfPayments": ["E-COMMERCE"]Correct: "modeOfPayments": ["ECOM"]Solution: Use exact enum values from this documentationNext Steps
Onboard Merchant API
Use these enums in your onboarding requests
Authentication
Set up JWT authentication
Introduction
Back to Onboarding API overview
Error Handling
Handle validation errors