ChargebackWorkflow APIs

Get /api/v3/chargebackWorkflow

Operation: GetChargebackWorkflowsV3 Permissions: ChargebacksModule (View)

Get a list of chargeback workflows


Post /api/v3/chargebackWorkflow

Operation: CreateChargebackWorkflowV3 Permissions: Chargebacks (Manage)

Create a chargeback workflow


Get /api/v3/chargebackWorkflow/{chargebackWorkflowId}

Operation: GetChargebackWorkflowV3 Permissions: ChargebacksModule (View)

Get a chargeback workflow


Put /api/v3/chargebackWorkflow/{chargebackWorkflowId}

Operation: EditChargebackWorkflowV3 Permissions: Chargebacks (Manage)

Edit a chargeback workflow


Delete /api/v3/chargebackWorkflow/{chargebackWorkflowId}

Operation: DeleteChargebackWorkflowV3 Permissions: Chargebacks (Manage)

Delete a chargeback workflow


Get /api/v3/chargebackWorkflowStep

Operation: GetChargebackWorkflowStepsV3 Permissions: ChargebacksModule (View)

Get a list of chargeback workflow steps


Get /api/v3/chargebackWorkflowStep/{chargebackWorkflowStepId}

Operation: GetChargebackWorkflowStepV3 Permissions: ChargebacksModule (View)

Get a single chargeback workflow step


Put /api/v3/chargebackWorkflowStep/{chargebackWorkflowStepId}/billingPeriod/{billingPeriod}/version

Operation: AssignVersionsToStepV3 Permissions: Chargebacks (Manage)

Assign a list of bill split or calculate bill versions to a chargeback workflow step of the same type


Post /api/v3/chargebackWorkflowStep/{chargebackWorkflowStepId}/void

Operation: VoidChargebackWorkflowStepsV3 Permissions: ChargebackReversals (Manage)

Void all bills created by a chargeback workflow step for a particular billing period
If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided
If this is a split step, any source bills will be reset to has not been split
If any bills have already been exported they will still be voided


Post /api/v3/chargebackWorkflowStep/{chargebackWorkflowStepId}/delete

Operation: DeleteChargebackWorkflowStepsV3 Permissions: ChargebackReversals (Manage)

Delete all bills created by a chargeback workflow step
If this workflow step was run multiple times, all bills created across all runs for the billing period will be voided
If this is a split step, any source bills will be reset to has not been split
If any bills have already been exported they will still be deleted


Get /api/v3/chargebackWorkflow/{chargebackWorkflowStepId}/digest

Operation: GetChargebackWorkflowDigestV3 Permissions: ChargebacksModule (View)

Get a digest of all bills by meter for all meters involved in a chargeback workflow step for a given billing period.