Create capability request

Creates a capability request for one product_code on the account the credentials belong to — an account_id in the body is ignored for merchant keys. Only one open request per product code is allowed; an account_update is rejected only when it touches a field or document an open request already changes.

The account must be activated first: payment-method, tax-document and account-update requests are rejected with 400 until it is. Check a payment method with GET /v1/requests/eligibility/{product_code} before submitting.

kyb_data depends on product_code — pick its shape and an example from the request body below. Attach documents by sending multipart/form-data: the JSON body in a part named payload, plus one files_<purpose> part per document. Without documents, send plain application/json.

The request is created submitted. An account update that changes only business_size and/or business_age is approved on the spot and comes back completed; a request whose business website is on PayMongo's prohibited list comes back declined.

Per-product rules, the documents each business type needs, document purposes, upload limits and the request lifecycle are in the Capability requests API guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

AccountID is the account the request belongs to. On create, a merchant key is locked to its own account and any value sent here is ignored; service-to-service callers have no bound account and must supply it.

kyb_data
object

Pick the shape for the request's product_code. Any files_<purpose> key beyond the ones listed is also accepted and stored verbatim (except files_draft).

string
enum
required

ProductCode is what is being asked for, and it drives every behaviour: the expected kyb_data shape, the verification rule, the status the request is created in, what approval writes and which emails go out.

Allowed:
string
enum
required

account_update for prd_svc_paymongo_account_update, onboarding for every other product.

Allowed:
string
required

RequesterID identifies who initiated the request. Caller-supplied. Required, but not validated for shape and not used for authorization.

Headers
string

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.

string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json