Create Channel

post

https://{yourLidiaUrl}/collector/payments/channel/create

Registers and instantiates a new channel resource in the financial collection engine.

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 payment channel command.

channelId

string

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

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

code

string | null

The unique alphanumeric identifier code for the transaction or resource.

name

string | null

The user-friendly label or name identifying the wallet or merchant record.

communicationType

string

enum

Allowed values: Sync (1), Async (2).

Allowed:

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.