Skip to main content
PUT
Update Onboarding Data

Overview

Updates the onboarding data for a merchant using the onboarding reference number. This endpoint allows merchants to correct and resubmit their information after their application has been declined.
Status Requirement: Regular users can only update merchants in DECLINED status. Upon successful update, the merchant’s status changes to PENDING for re-review.
Updates are accepted only for records in the DECLINED state, which then move to PENDING for re-review.

Authentication

This endpoint requires JWT Bearer Token authentication.

Authorization Rules

Transaction Behavior

Atomic update: Either all changes in a request are applied, or none are.
The update process includes:
  1. Validating all request parameters
  2. Checking user authorization and merchant status
  3. Updating business information
  4. Updating incorporators and signatories
  5. Updating addresses and representatives
  6. Updating bank accounts
  7. Changing status to PENDING (for regular users)
If any step fails, no changes are persisted.

Validation Rules Summary

Business Type

Non-STARTER businesses require legalName and businessHandle

Bank Accounts

When not NO_ACCOUNT: bankName, accountName, accountNumber, currency required

Bank Type

When accountDepositType is BANK: accountType is also required

Website

If businessWebsiteUrl provided: isBusinessWebsiteUnderDevelopment required

Status Change Flow

1

Merchant is DECLINED

Admin has declined the merchant’s onboarding application with a reason
2

Merchant Updates Data

Merchant corrects the issues and submits update via this endpoint
3

Status Changes to PENDING

Upon successful update, status automatically changes to PENDING
4

Admin Re-reviews

Admin reviews the updated information and either approves or declines again

Use Cases

Fix Declined Application

Correct issues identified in decline reason and resubmit

Update Business Info

Update business details after changes

Add Missing Documents

Add information that was missing in original submission

Correct Validation Errors

Fix validation issues from initial onboarding

Troubleshooting

Error: Unable to update. Merchant is not in declined status.Issue: Regular users cannot update approved merchantsSolution:
  • Only DECLINED merchants can be updated by regular users
  • Approved records are updated only through Modulus review.
  • To update business details after approval, create a new onboarding request
Issue: Update fails with Failed to update onboarding recordPossible Causes:
  • Database connectivity issues
  • Data integrity constraints violated
  • Concurrent updates from multiple sources
Solution:
  • Retry the request after a short delay
  • Ensure no concurrent updates are happening
  • Contact support if issue persists
Issue: Getting validation errors like merchantName is requiredSolution:
  • Ensure ALL required fields from original onboarding are included
  • Don’t just send changed fields - send complete data
  • Use retrieve endpoint to get current data first
  • Validate against the same rules as initial onboarding

Field Validation Reference

  • First/Middle/Last Names: 1-100 chars, Unicode letters, spaces, hyphens, apostrophes
  • Email: Valid email format, max 100 chars
  • TIN: Numbers only, max 20 chars
  • Postal Code: 4-10 digits, numbers only
  • Contact Number: Numbers only, max 30 chars
  • SSS: Exactly 10 digits

Next Steps

Retrieve Onboarding Data

Get current onboarding data before updating

Retrieve Status

Check if merchant is in DECLINED status

Onboard Merchant

View original onboarding endpoint documentation

Error Handling

Complete error code reference

Authorizations

Authorization
string
header
required

JWT Bearer token authentication

Path Parameters

refNo
string<uuid>
required

The onboarding reference number (UUID v4 format)

Body

application/json

Resubmit a declined application. Unlike a partial patch, the service revalidates the full business profile: the fields below marked required must all be present. businessType and parentOnboardingRefNo are set on the initial submission (POST /v2/onboard) and cannot be changed here.

merchantName
string
required

Trading name or DBA (Doing Business As) name

Maximum string length: 500
modeOfPayments
enum<string>[]
required

List of accepted payment modes

Minimum array length: 1
Available options:
TERMINAL,
ECOM,
PAYMENT_LINK,
QRPH,
PAY_WITH_MAYA
currency
enum<string>
required

Primary currency for transactions

Available options:
PHP,
USD
tin
string
required

Tax Identification Number

Maximum string length: 20
Pattern: ^\d+$
industry
string
required

Business industry category

Maximum string length: 200
serviceDescription
string
required

Description of services or products offered

isBrickAndMortarStore
boolean
required

Whether the business has a physical store location

address
object
required
representatives
object
required
banks
object[]
required

List of bank accounts for settlement

Required array length: 1 - 2 elements
isWantPackworksWallet
boolean
required

Whether the merchant wants a wallet.

isWantPayMayaWallet
boolean
required

Whether the merchant wants a Maya wallet.

isWantPayMayaBankAccount
boolean
required

Whether the merchant wants a Maya bank account.

Legal registered name of the business (required for non-STARTER types)

Maximum string length: 500
businessHandle
string

Unique business handle/slug for payment links (required for non-STARTER types)

Pattern: ^([A-Za-z]|[0-9]|_|-)+$
incorporators
object[]

List of business incorporators (for non-STARTER types)

Required array length: 1 - 5 elements
signatories
object[]

List of authorized signatories

Required array length: 1 - 5 elements
websites
object
aubPartnerId
string

Optional partner identifier.

estimatedMonthlyGrossTransaction
string

Optional estimated monthly gross transaction volume.

Response

Onboarding data updated successfully

onboardingStatus
enum<string>

Always PENDING after a resubmission; the application returns to review.

Available options:
PENDING
onboardingReferenceNumber
string<uuid>

The onboarding reference number (unchanged)