PROPAY_SUCCESS Event

This webhook event is sent when a ProPay account provisioning operation completes successfully. This includes onboarding operations, document sync operations, and account updates.

When This Event Is Sent

The endpoint propay.execute is used, and the execution is successful.
A user performs an ProPay execution from the Underwriters Dashboard, and the execution is successful.

Decrypted Data Parameters

This event includes all default parameter for version 1.0 in the decrypted data parameter, plus the following parameters:

Parameter	Type	Required	Description
provisioning_data	object	Yes	Complete ProPay provisioning entity data including execution results. See ProPay Parameters below.

ProPay Parameters

The provisioning_data object contains the complete ProPay provisioning entity state, identical to the response from propay.get.

For detailed documentation of all fields in the provisioning_data object, refer to the propay.get endpoint documentation.

Example Payload

Note: This example shows the decrypted payload. When you receive this webhook, the data field will be encrypted. See the encryption reminder for details.

{
  "id": "wh_5cbd0p9auRSRH1bUmkgcKs",
  "event_type": "PROPAY_SUCCESS",
  "timestamp": "2026-03-18T22:17:39Z",
  "account_id": "account_id",
  "schema_version": "2025-11-21",
  "key_id": "whk_20260318_03",
  "data": {
    "version": "1.0",
    "subject_record_id": "sr_2dkK9FIcyDxkxsd0BeB4MU",
    "workflow_id": "w_4CYe7i8KbV5H6lry45aUKp",
    "workflow_type": "ACCOUNT_PROVISIONING",
    "user_context": {
      "user_id": "SYSTEM",
      "user_type": "SYSTEM"
    },
    "provisioning_data": {
      "provisioning_type": "PROPAY",
      "provisioning_sponsor": "GLOBAL_PAYMENTS",
      "status": "CREATED",
      "propay_id": "ape_16Jh2p6s6fB6SiErRHTIwZ",
      "created_at": "2026-03-18T22:17:26.254Z",
      "updated_at": "2026-03-18T22:17:26.332Z",
      "execution_results": [
        {
          "errors": [],
          "status": "SUCCESS",
          "started_at": "2026-03-18T22:17:26.752Z",
          "finished_at": "2026-03-18T22:17:28.954Z",
          "operation_id": "apo_4tPEUI65XxVBWVsridVq78",
          "operation_type": "onboarding",
          "provider_response": {
            "code": "00",
            "details": {
              "Tier": "test",
              "Status": "00",
              "Password": "[REDACTED]",
              "KYCResponse": null,
              "SourceEmail": "[REDACTED]",
              "AccountNumber": 718730571,
              "CreditCheckConsent": null,
              "BeneficialOwnerDataResult": [
                {
                  "Status": "Validated",
                  "LastName": "Kiehn",
                  "FirstName": "Noel"
                }
              ],
              "GatewayBoardingResultData": []
            },
            "message": "Operation completed successfully.",
            "external_reference_id": 718730571
          }
        }
      ]
    }
  },
  "retry_count": 2
}

Using the Provisioning data

After receiving this webhook, you can use the propay_id to download the document via the propay.get