Cancel

post

https://{yourlidiaurl}/collector/charging/cancel

Executes the cancel collection workflow process.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input command payload containing target properties.

Command request payload containing variables required to execute cancellation command.

txnSessionId

string | null

The unique database identifier linking this record to the target txn session.

description

string | null

Detailed metadata or transaction narration text.

cancellationDate

date-time | null

Gets or sets the cancellation date configuration value.

transactionId

string

^-?(?:0|[1-9]\d*)$

The unique database identifier linking this record to the target transaction.

txnRefNumber

string | null

Gets or sets the txn ref number configuration value.

lineId

string | null

The unique database identifier linking this record to the target line.

cancellationAmount

string

^-?(?:0|[1-9]\d*)(?:\.\d+)?$

Gets or sets the cancellation amount configuration value.

lines

array of objects | null

Gets or sets the lines configuration value.

lines

additionalParameters

string | null

Gets or sets the additional parameters configuration value.

environment

string | null

Gets or sets the environment configuration value.

applicationIP

string | null

Gets or sets the application ip configuration value.

userToken

string | null

Gets or sets the user token configuration value.

sessionId

string | null

The unique database identifier linking this record to the target session.

userId

string

^-?(?:0|[1-9]\d*)$

The unique database identifier linking this record to the target user.

userIP

string | null

Gets or sets the user ip configuration value.

envelope

string | null

Gets or sets the envelope configuration value.

culture

string | null

Gets or sets the culture configuration value.

threadId

string | null

A correlation token used to track logs across async thread transitions.

status

string

enum

Allowed values: Draft (0), Active (1), Unknown (-999), Deleted (-99), Blocked (-12), Freezed (-11), Test (-9), Passive (-1).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200An IActionResult indicating the operation outcome.