PApaymongo
Capability Requests

Get payment-method requirements / eligibility

Evaluates the authenticated account against a payment method's requirements. Returns eligible=true when the account qualifies, otherwise eligible=false with the list of missing business type / documents / fields — the same set enforced when creating a request.

An account that has not completed activation is reported as eligible=false with a single missing entry of type account_activation, matching the 400 the create endpoint would return.

get/v1/requests/eligibility/{product_code}

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/requests/eligibility/{product_code}
  • Auth
    • HTTP basic
    • or HTTP bearer

Path parameters

product_codestring required

Product code

Query parameters

account_idstring

Account ID (S2S only; ignored for merchant/client auth, which is locked to its own account)

Headers

Account-IDstring

Organization ID of a child account to act on behalf of. Requires an enabled linked-transactions relationship in which the authenticated parent FULLY MANAGES that child, and a grant covering this route. Merchant (Basic) auth only.

Response

OK

has_moreboolean

Example response

{
  "data": {
    "missing": [
      {
        "key": "sec_registration",
        "label": "SEC registration is required",
        "type": "document"
      }
    ],
    "product_code": "prd_svc_paymongo_ewallet_gcash"
  }
}

Changes

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