UpdateRefundState

post

https://{yourlidiaurl}/order/orders/refunds/updatestate

Updates the state of an existing refund.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The refund identifier and the new state.

refundId

string

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

Gets or sets the refund id.

orderId

string

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

Gets or sets the order id.

processId

string

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

Gets or sets the process id.

rootTransactionId

string

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

Gets or sets the root transaction id.

transactionId

string

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

Gets or sets the transaction id.

refundChannel

string | null

Gets or sets the refund channel.

amount

string

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

Gets or sets the amount.

currency

string | null

Gets or sets the currency.

plannedRefundDate

date-time | null

Gets or sets the planned refund date.

refundDate

date-time | null

Gets or sets the refund date.

state

string

enum

Allowed values: Draft (0), Pending (10), Scheduled (20), Completed (30), Deleted (-999).

Allowed:

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

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

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

userEmail

string | null

Gets or sets the email address of the user performing the operation.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

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

200The refund with the updated state.