Do

post

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

Executes the do 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 charging command.

txnSessionId

string | null

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

txnRefNumber

string | null

Gets or sets the txn ref number configuration value.

channelCode

string | null

Gets or sets the channel code configuration value.

transactionMedium

transactionType

string

enum

Allowed values: None (0), CC_Provision (1), CC_ProvisionCommit (2), CC_Sale (3), CC_SaleCancel (4), CC_Refund (5), CC_ProvisionCancel (6), CC_ProvisionCommitCancel (7), WireTransfer (10), WireTransferCancel (11), SalesNote (20), Loan (21), LoanCancel (22), Wallet (23), SubPaymentUpdate (24), PaymentStatusQuery (25), Cash (30).

transactionModel

string

enum

Allowed values: Standard (0), Marketplace (1).

Allowed:

securityLevel

paymentOptionId

string

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

The unique database identifier linking this record to the target payment option.

paymentChannelAccountId

string

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

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

rawAmount

string

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

Gets or sets the raw amount configuration value.

amount

string

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

The financial amount value for the transaction.

subTotal

string

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

Gets or sets the sub total configuration value.

loyaltyPointRedemption

string

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

Gets or sets the loyalty point redemption configuration value.

installmentCount

string

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

Gets or sets the installment count configuration value.

currency

string | null

The ISO three-letter currency code (e.g. TRY, USD, EUR) used for the payment.

successUrl

string | null

Gets or sets the success url configuration value.

asyncSuccessUrl

string | null

Gets or sets the async success url configuration value.

errorUrl

string | null

Gets or sets the error url configuration value.

cancelUrl

string | null

Gets or sets the cancel url configuration value.

payerFirstname

string | null

Gets or sets the payer firstname configuration value.

payerLastname

string | null

Gets or sets the payer lastname configuration value.

payerCitizenId

string | null

The unique database identifier linking this record to the target payer citizen.

payerEmail

string | null

Gets or sets the payer email configuration value.

payerPhone

string | null

Gets or sets the payer phone configuration value.

payerDeliveryFirstname

string | null

Gets or sets the payer delivery firstname configuration value.

payerDeliveryLastname

string | null

Gets or sets the payer delivery lastname configuration value.

payerDeliveryPhone

string | null

Gets or sets the payer delivery phone configuration value.

payerDeliveryAddress

string | null

Gets or sets the payer delivery address configuration value.

payerDeliveryDistrict

string | null

Gets or sets the payer delivery district configuration value.

payerDeliveryCity

string | null

Gets or sets the payer delivery city configuration value.

payerDeliveryCountry

string | null

Gets or sets the payer delivery country configuration value.

payerBillingFirstname

string | null

Gets or sets the payer billing firstname configuration value.

payerBillingCompanyName

string | null

Gets or sets the payer billing company name configuration value.

payerBillingLastname

string | null

Gets or sets the payer billing lastname configuration value.

payerBillingPhone

string | null

Gets or sets the payer billing phone configuration value.

payerBillingAddress

string | null

Gets or sets the payer billing address configuration value.

payerBillingDistrict

string | null

Gets or sets the payer billing district configuration value.

payerBillingCity

string | null

Gets or sets the payer billing city configuration value.

payerBillingState

string | null

Gets or sets the payer billing state configuration value.

payerBillingCountry

string | null

Gets or sets the payer billing country configuration value.

payerBillingTaxOffice

string | null

Gets or sets the payer billing tax office configuration value.

payerBillingTaxNumber

string | null

Gets or sets the payer billing tax number configuration value.

cardUserKey

string | null

Gets or sets the card user key configuration value.

cardToken

string | null

Gets or sets the card token configuration value.

cardOwner

string | null

Gets or sets the card owner configuration value.

cardNumber

string | null

The masked or encrypted credit card number used for billing.

expireMonth

string

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

Gets or sets the expire month configuration value.

expireYear

string

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

Gets or sets the expire year configuration value.

cvv2

string | null

Gets or sets the cvv2 configuration value.

saveCreditCard

string

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

Gets or sets the save credit card configuration value.

paymentAccountId

string | null

The unique database identifier linking this record to the target payment account.

orderId

string | null

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

modifyOrderId

boolean

The unique database identifier linking this record to the target modify order.

products

array of objects | null

Gets or sets the products configuration value.

products

paymentConfiguration

object

paymentPromotionConfiguration

object

appliedPromotions

array of objects | null

Gets or sets the applied promotions configuration value.

appliedPromotions

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.