Accounts

Create Account

Create a new child account (merchant or consumer) with minimal data.

post/v2/accounts

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v2/accounts
  • Auth
    HTTP basic

Request body

type'merchant' | 'consumer' required

Account type.

fully_managedboolean

Set true to give the parent full access to every current and future resource on this account. Only parents that have opted in to full-access delegation can use it. Other parents receive 403. Do not combine it with policy_selection. When omitted or false, the relationship receives the permissions in policy_selection, or the default grant set when that is also omitted.

policy_selectionobject

Permissions the parent holds on the new account. Same keys and options as the invite; see GET /v2/linking_requests/policy_menu. Omitted resources are none. The wildcard is not accepted here; use fully_managed for full access. Omitting the field applies the default grant set. Do not combine it with fully_managed.

Example request

{
  "type": "merchant",
  "policy_selection": {
    "transfer": {
      "view": "global",
      "manage": "global"
    },
    "payment": {
      "view": "global",
      "manage": "related"
    }
  }
}

Response

Account created successfully

Example response

{
  "data": {
    "id": "org_zeZdrgooHpjxzDpwvAsHXEAr",
    "type": "consumer",
    "activation_status": "pending",
    "person": {
      "type": "representative",
      "first_name": "Juan",
      "last_name": "Dela Cruz",
      "middle_name": "Clara",
      "mobile_number": "+639569999999",
      "email_address": "juan@delacruz.com",
      "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_salary": "ABC Corporation",
      "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": "pending"
    },
    "bank": {
      "id": "bank_xxxxxxxxxx",
      "account_name": "Juan Dela Cruz",
      "account_number": "1234567890",
      "bank_name": "BDO"
    },
    "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": 1,
        "month": 1,
        "year": 1990
      },
      "description": "E-commerce store selling electronics",
      "dti_registered_name": "ABC Trading",
      "estimated_monthly_volume": "between_300K_and_500K",
      "handle": "abc-store",
      "industry": "5999",
      "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": 1680000000,
    "relationship": {
      "id": "mr_1a2b3c4d5e6f7a8b9c0d1e2f",
      "policies": {
        "transfer": {
          "ViewTransfer": {
            "label": "View all transfers",
            "policy_id": null
          },
          "ManageTransfer": {
            "label": "Manage all transfers",
            "policy_id": null
          }
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.