Payments - Flows

Create workflow execution

Validate the "workflow-config" previously created by utilizing the unique "configId". This step requires the mandatory field amount, and allows for modifications to other fields defined via the "workflow-config" endpoint, including pre-screening preferences. A response containing the "workflowExecutionId" and detailing the validation status will be provided. Execution is ready when the "workflow-execution" status is READY_FOR_LAUNCH, at which point it can be initiated with "POST /workflow-execution/{workflowExecutionId}/actions/execute".

post/payments/workflow_execution

Request

Headers

Idempotency-Keystring

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Request body

configIdstring required

Response

Workflow execution entity has been created successfully.

executionIdstring required
status'PENDING' | 'VALIDATION_IN_PROGRESS' | 'VALIDATION_FAILED' | 'VALIDATION_COMPLETED' | 'PREVIEW_IN_PROGRESS' | 'PREVIEW_FAILED' | 'READY_FOR_LAUNCH' | 'EXECUTION_IN_PROGRESS' | 'EXECUTION_COMPLETED' | 'EXECUTION_FAILED' required
triggeredBystring
triggeredAtnumber
finishedAtnumber

Changes

No recorded changes to this operation across all 1 revision of this API.