DeletePaymentRequest

post

https://{yourlidiaurl}/collector/payments/paymentrequests/delete

Permanently discards the specified payment request record from the active registers.

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 request command.

requestId

string

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

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

walletId

string

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

The unique database identifier of the associated customer wallet.

clientIP

string | null

Gets or sets the client ip configuration value.

string | null

Gets or sets the email configuration value.

mobileNumber

string | null

Gets or sets the mobile number configuration value.

orderId

string | null

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

invoiceId

string | null

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

subscriptionId

string | null

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

amount

string

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

The financial amount value for the transaction.

currency

string | null

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

description

string | null

Detailed metadata or transaction narration text.

requestReferenceNumber

string | null

Gets or sets the request reference number configuration value.

code

string | null

The unique alphanumeric identifier code for the transaction or resource.

erpCode

string | null

Gets or sets the erp code configuration value.

feedBackUrl

string | null

Gets or sets the feed back url configuration value.

firstPayment

date-time | null

Gets or sets the first payment configuration value.

lastAttempt

date-time | null

Gets or sets the last attempt configuration value.

lastPayment

date-time | null

Gets or sets the last payment configuration value.

nextPayment

date-time | null

Gets or sets the next payment configuration value.

type

string

enum

Allowed values: Onetime (1), Recurring (2).

Allowed:

paymentFrequency

string | null

Gets or sets the payment frequency 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.