GetPaymentRequest

post

https://{yourlidiaurl}/collector/query/paymentrequests

Fetches detailed metadata, current balances, and state of the target payment request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input command payload containing target properties.

Query parameter filters defining constraints to search or list payment request query.

requestIds

array | null

Gets or sets the request ids configuration value.

requestIds

walletIds

array | null

Gets or sets the wallet ids configuration value.

walletIds

emails

array of strings | null

Gets or sets the emails configuration value.

emails

mobileNumbers

array of strings | null

Gets or sets the mobile numbers configuration value.

mobileNumbers

orderIds

array of strings | null

Gets or sets the order ids configuration value.

orderIds

invoiceIds

array of strings | null

Gets or sets the invoice ids configuration value.

invoiceIds

subscriptionIds

array of strings | null

Gets or sets the subscription ids configuration value.

subscriptionIds

requestReferenceNumbers

array of strings | null

Gets or sets the request reference numbers configuration value.

requestReferenceNumbers

codes

array of strings | null

Gets or sets the codes configuration value.

codes

erpCodes

array of strings | null

Gets or sets the erp codes configuration value.

erpCodes

types

array of objects | null

Gets or sets the types configuration value.

types

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.

threadId

string | null

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

includes

array of strings | null

Gets or sets the includes configuration value.

includes

searchKey

string | null

Gets or sets the search key configuration value.

pageIndex

string

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

Gets or sets the page index configuration value.

pageSize

string

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

Gets or sets the page size configuration value.

sorting

string | null

Gets or sets the sorting configuration value.

prefix

string | null

Gets or sets the prefix configuration value.

status

array of objects | null

Gets or sets the status configuration value.

status

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.