Initiate Propay account provisioning operations for onboarding or document synchronization.

POST http://api.kompliant.com/propay.execute (OpenAPI specification)

Usage Info

Use this method to initiate Propay account provisioning. This method should only be called after propay.canExecute confirms all requirements are met. The operation type (currently, the only supported operation for Propay is ONBOARDING) is determined automatically based on the entity's current state and the merchant's onboarding status.

Operations are processed asynchronously. Use propay.get to check execution status and results.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
propay_id	string	Yes	The identifier for the Propay provisioning entity.

Example

{
  "propay_id": "ape_7h1EpxerrZQyLnRC1EQ9Ck"
}

Response

Data

Parameter	Type	Description
propay	object	The propay parameter is defined in the table below.

Propay Parameters

Parameter	Type	Description
propay_id	string	The identifier for the Propay provisioning entity.
queued_operations	array	Account provisioning operations that have been queued for processing. Each operation is one of ACCOUNT_PROVISIONING_OPERATIONS. Current Operation supported for Propay is: `ONBOARDING`

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6zNzQZHSf26V83BO3uW6dS",
    "version": "2025-03-24"
  },
  "data": {
    "propay": {
      "propay_id": "ape_7h1EpxerrZQyLnRC1EQ9Ck",
      "queued_operations": [
        "ONBOARDING"
      ]
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided.
ENTITY_NOT_FOUND	400	The `propay_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System rule violations are described below.
ACCOUNT_CONFIGURATION_VIOLATION	400	Account configuration rule violations are described below.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
Workflow	WORKFLOW_NOT_STARTED	The workflow must be in STARTED state before executing provisioning operations.
AccountProvisioning	PRECHECK_FAILED	Precheck validation failed. Use `propay.canExecute` to identify missing requirements before calling execute.
AccountProvisioning	BUSINESS_NOT_FOUND	No business found for the subject record associated with this entity.

Account Configuration Violations

When a ACCOUNT_CONFIGURATION_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity Type	Sub-code	Description
AccountProvisioning	ACCOUNT_PROVISIONING_DISABLED	The account provisioning feature is disabled for this account.
AccountProvisioning	PROVISIONER_DISABLED	The Propay provisioner is disabled for this account.