Enums

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

{
  "businessType": "STARTER"
}

STARTER

Best for: Small businesses, sole traders, freelancersRequirements:

Barangay Business Permit
No incorporators needed
No registered address needed
Legal name optional

Settlement accounts: Must provide at least one bank account

SOLE_PROPRIETOR

Best for: Individual business ownersRequirements:

1 incorporator required
Legal name required
Registered address required
Additional KYC documents

Typically 1 incorporator. The schema itself accepts 1 to 5 incorporators; per-business-type counts are a guideline, not an API-enforced rule.

PARTNERSHIP

Best for: Business partnerships, joint venturesRequirements:

2 incorporators required
Legal name required
Registered address required
Partnership agreement documents

Typically 2 incorporators. The schema accepts 1 to 5; the count is a guideline, not API-enforced.

CORPORATION

Best for: Registered corporationsRequirements:

Minimum 3 incorporators required
Legal name required
Registered address required
Corporate registration documents

Typically 3 or more incorporators. The schema accepts 1 to 5; the count is a guideline, not API-enforced.

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

{
  "modeOfPayments": ["ECOM", "QRPH", "PAYMENT_LINK"]
}

Merchants can enable multiple payment methods. Provide an array of values based on the merchant’s needs.

Currency

Three-letter ISO 4217 currency codes for customer transactions.

Value	Description
`PHP`	Philippine Peso
`USD`	United States Dollar

Usage Example

{
  "currency": "PHP"
}

Currently, only PHP and USD are supported. The default currency is PHP.

Bank Names

bankName is free text (up to 500 characters) - the name of the bank holding the settlement account. There is no fixed enum on the v2 onboarding API; send the bank’s name as a plain string.

Usage Example

{
  "banks": [
    {
      "accountDepositType": "BANK",
      "bankName": "BDO Unibank",
      "accountType": "SAVINGS",
      "accountName": "Business Corporation",
      "accountNumber": "1234567890",
      "currency": "PHP"
    }
  ]
}

Bank Account Type

Account type for traditional bank accounts.

Value	Description
`SAVINGS`	Savings Account
`CHECKING_CURRENT`	Checking/Current Account

Usage Example

{
  "accountType": "SAVINGS"
}

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

{
  "accountDepositType": "BANK",
  "accountType": "SAVINGS",
  "bankName": "BDO Unibank",
  "accountName": "Business Corp",
  "accountNumber": "1234567890",
  "currency": "PHP"
}

{
  "accountDepositType": "GCASH",
  "bankName": "GCASH",
  "accountName": "Juan Dela Cruz",
  "accountNumber": "09123456789"
}

{
  "accountDepositType": "PAYMAYA",
  "bankName": "PAYMAYA",
  "accountName": "Maria Santos",
  "accountNumber": "09987654321"
}

BANK - Traditional Bank Account

Required fields:

accountType (SAVINGS or CHECKING_CURRENT)
bankName (the bank’s name, free text)
accountName
accountNumber
currency

Use for: Standard bank transfers and settlements

GCASH - E-wallet

Required fields:

bankName (must be “GCASH”)
accountName
accountNumber (GCash mobile number)

Use for: GCash wallet settlements

The account number should be the GCash mobile number (e.g., “09123456789”)

PAYMAYA - E-wallet

Required fields:

bankName (must be “PAYMAYA”)
accountName
accountNumber (PayMaya mobile number)

Use for: PayMaya wallet settlements

NO_ACCOUNT

Use for: Special cases where no settlement account is needed

Contact Modulus Labs before using NO_ACCOUNT to confirm it’s appropriate for your use case.

Gender

Gender options for incorporators and representatives.

Value	Description
`MALE`	Male gender
`FEMALE`	Female gender

Usage Example

{
  "gender": "MALE"
}

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

When: Initial merchant onboarding submissionMerchant Action: Wait for Modulus Labs reviewNext Steps: Status will change to either APPROVED or DECLINED

APPROVED

When: Merchant passes KYC verificationMerchant Action: Can start accepting paymentsNote: Approved merchants can be declined later if compliance issues are discovered

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

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	1-20 characters	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

Avoid these common enum-related errors:

Wrong Capitalization

Wrong: "businessType": "starter" or "GCASH" as bankName for bank typeCorrect: "businessType": "STARTER" and proper account deposit typeSolution: Always use uppercase for enum values

Invalid Bank for Deposit Type

Wrong:

{
  "accountDepositType": "BANK",
  "bankName": "GCASH"
}

Correct:

{
  "accountDepositType": "GCASH",
  "bankName": "GCASH"
}

Solution: Match bankName with accountDepositType

Incorporator count

The schema accepts 1 to 5 incorporators. Sending zero or more than five is rejected. The per-business-type counts above (1 for sole proprietor, 3+ for a corporation) are a guideline for approval, not an API validation - your application can submit with a different count and be reviewed on its merits.

Invalid Enum Value

Wrong: "modeOfPayments": ["E-COMMERCE"]Correct: "modeOfPayments": ["ECOM"]Solution: Use exact enum values from this documentation

Next 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

Get Started

QR API

Webhooks API

Onboarding API

Terminal Gateway API

Transaction Reporting API

Ecom API

Shared Resources

Overview

Business Type

Usage Example

Mode of Payment

Usage Example

Currency

Usage Example

Bank Names

Usage Example

Bank Account Type

Usage Example

Bank Account Deposit Type

Usage Examples

Gender

Usage Example

Onboarding Status

Status Flow

Validation Quick Reference

Common Mistakes

Next Steps

Onboard Merchant API

Authentication

Introduction

Error Handling

​Overview

​Business Type

​Usage Example

​Mode of Payment

​Usage Example

​Currency

​Usage Example

​Bank Names

​Usage Example

​Bank Account Type

​Usage Example

​Bank Account Deposit Type

​Usage Examples

​Gender

​Usage Example

​Onboarding Status

​Status Flow

​Validation Quick Reference

​Common Mistakes

​Next Steps

Onboard Merchant API

Authentication

Introduction

Error Handling

Overview

Business Type

Usage Example

Mode of Payment

Usage Example

Currency

Usage Example

Bank Names

Usage Example

Bank Account Type

Usage Example

Bank Account Deposit Type

Usage Examples

Gender

Usage Example

Onboarding Status

Status Flow

Validation Quick Reference

Common Mistakes

Next Steps