Skip to main content

Understanding User Personal

CAPAY OpenAPI supports two types of users:

  • PM (Program Manager) : Has at least one client, initiating requests for them.
  • Client: Initiates requests directly.

API User and Beneficiary

Additionally, the interaction and parameter requirements differ based on the user type.

  • For PMs, the clientId parameter is mandatory when creating a transaction, as PMs cannot act as entities for any B2B or B2C transactions. In other scenarios, clientId is optional—if not provided, the PM is considered the acting entity; if provided, the operation targets the Client associated with the specified clientId.
  • For Clients, the clientId parameter is optional in all scenarios, and by default, the operation applies to the Client making the API call without needing additional specification.