PApaymongo
Internal Capability Requests

Move request to pending clarification (S2S only)

Transitions request status to pending_clarification from under_review or processing. Records the clarification needed with required internal note explaining what needs to be clarified. The optional requested_fields / requested_files arrays name the exact kyb_data fields and document purposes the merchant must resubmit; they are stored alongside the merchant note and returned on the request's merchant_note object.

post/v1/internal/requests/{id}/pending_clarification

Request

  • Base URL
    https://api.paymongo.com
  • URL
    https://api.paymongo.com/v1/internal/requests/{id}/pending_clarification
  • Auth
    HTTP bearer

Path parameters

idstring required

Request ID

Request body

internal_notestring required
merchant_notestring required

MerchantNote is required for pending-clarification — the merchant needs to know what to fix. It is stored (with the timestamp it was set) in the request's dedicated merchant_note column, so merchants can read it from GET /v1/requests. Do not put internal-only context here — use internal_note.

requested_custom_filesstring[]

RequestedCustomFiles names documents that are not in the purpose list, e.g. ["Lease contract"]. Optional. Each name is one more "others" upload for the merchant; names are trimmed, blanks dropped, and the list is capped.

requested_fieldsstring[]

RequestedFields names the kyb_data field keys the merchant must resupply, e.g. ["business_website"]. Optional — omitted or empty means the note alone explains what to fix. Contents are not validated against a whitelist: the field set is defined frontend-side and changes more often than this endpoint.

requested_filesstring[]

RequestedFiles names the document purposes the merchant must re-upload, without the files_ prefix, e.g. ["bir_certificate_of_registration"]. Optional, and not validated against a whitelist — same reasoning as requested_fields.

Example request

{
  "internal_note": "Waiting on updated proof of billing",
  "merchant_note": "Please upload a recent proof of billing under the business name",
  "requested_custom_files": [
    "Lease contract",
    "Proof of delivery"
  ],
  "requested_fields": [
    "business_website",
    "business_legal_name"
  ],
  "requested_files": [
    "bir_certificate_of_registration",
    "sworn_declaration"
  ]
}

Response

OK

has_moreboolean

Example response

{
  "data": {
    "account_id": "acct_01hzy8n3k2b5xq9m4p7r6t8w1v",
    "id": "req_01hzy8n3k2b5xq9m4p7r6t8w1v",
    "product_code": "prd_svc_paymongo_ewallet_gcash",
    "request_type": "onboarding",
    "requester_id": "org_01hzy8n3k2b5xq9m4p7r6t8w1v"
  }
}

Changes

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