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: It can be based on your institution or the underlying customer.

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. By default (when clientId is not provided), all actions apply to the Client itself (institutional). When clientId is provided, the operation targets the underlying customer managed by that Client.