post

/operations/get

Request to retrieve operations performed in the payment platform for specific merchant projects.

Request Body

Schema
object
project_id
array[integer]

Array of one or more project IDs. If array is omitted, the payment platform returns information for all projects accessible for the user account which is associated with the token specified in the token parameter.

interval
object

Time period with start and end times for which to retrieve data. By default, the response returns operations most recently completed.

tz
string

Name of time zone for the time period, for example UTC or Indian/Mauritius. Time zone name must be one of the names in the IANA time zone database.

limit
integer

Number of entries to return per request. Maximum and default value is 1000.

offset
integer

Pagination start offset. Specifies the number of entries to skip, before starting to return entries. Default value is 0.

operation_type
string

Operation type. One of the operation types supported by the ECommPay payment platform.

token
string

Token generated in ECommPay Dashboard for user account.

required
fields
array[string]

An array of one or more parameter names the values of which are needed to be returned for each operation in the response. In the array, the parameter names must be enclosed in matching quotation marks and separated by commas and can be specified in an arbitrary order (for example, operation_id, payment_id, project_id). However, in the response the parameter values are returned in the fixed order which, together with the list of parameters, is defined in the response specification. If the array is omitted, then the response contains the values of the required parameters for each operation.

signature
string

Digital signature generated by using secret key associated with the token specified in the token parameter.

required

Responses

OK

Schema
object

List of operations with operation details.

operations
array[object]
signature
string

Digital signature generated by using secret key (salt) of ECommPay Dashboard user account. The payment platform uses the same key that was previously used to sign the request.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.