Usage Info

The Propay Account Provisioning entity serves as the container for all provisioning activities related to merchant account setup with Global Payments.

Use this method to create a new provisioning entity with Global Payments.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

Parameter	Type	Required	Description
workflow_id	string	Yes	The Account Provisioning workflow to associate with this Propay entity. The workflow must be of type `ACCOUNT_PROVISIONING` and in `STARTED` state.
provisioning_sponsor	string	Yes	The sponsor for provisioning. Must be one of the ACCOUNT_PROVISIONING_SPONSORS.

Example

{
  "workflow_id": "w_2dJFFW3HY8a3zOjqwUXhQc",
  "provisioning_sponsor": "GLOBAL_PAYMENTS"
}

Response

Data

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

Propay Parameters

Parameter	Type	Description
propay_id	string	The identifier for the Propay Account Provisioning entity just created.
status	string	The initial status of the entity. Will be `created`. Must be one of the ACCOUNT_PROVISIONING_ENTITY_STATUSES.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_6OI5blm21ZoSlq0PC3RqJV",
    "version": "2025-03-24"
  },
  "data": {
    "propay": {
      "propay_id": "ape_4vrv6U1vdpc341MO7cF8pE",
      "status": "created"
    }
  }
}

Errors

Error Code	HTTP Code	Possible Cause
BAD_REQUEST	400	Required parameters not provided. The `provisioning_sponsor` provided is not one of the ACCOUNT_PROVISIONING_SPONSORS.
ENTITY_NOT_FOUND	400	The `workflow_id` provided does not exist.
SYSTEM_RULE_VIOLATION	400	System 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 creating an account provisioning entity.
Workflow	INVALID_PROVISIONING_SPONSOR	The provisioning_sponsor provided does not match the workflow's expected sponsor.
AccountProvisioningEntity	BUSINESS_APPLICATION_NOT_FOUND	No business application found for the subject record associated with this workflow.
Account	ACCOUNT_PROVISIONING_DISABLED	The account provisioning feature is disabled for this account.
Account	PROVISIONER_DISABLED	The ProPay provisioner is disabled for this account. Contact support to enable ProPay provisioning for your account.