Retrieve Adjustments - Staged

get

https://prod.emea.api.fiservapps.com/omnipay/financial/adjustments/v1.0/get-adjustments-staged

Retrieve list of adjustments that are staged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

adjustmentSlipNumber

string

length between 11 and 11

^[0-9]{11}$

Unique identifier of the individual adjustment.

batchSlipNumber

string

length between 11 and 11

^[0-9]{11}$

Unique identifier of the individual batch that has list of adjustments grouped.

merchantId

string

length between 8 and 8

^[0-9]{8,8}$

Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment is posted to.

adjustmentStatus

string

length between 3 and 3

^[0-9]{3}$

Status of the created adjustment. For a list of valid values, use Financial Adjustment API GET reference-data endpoint with query parameter "classification" equal to "adjustmentStatusIndex".

adjustmentCategory

string

enum

Indicates the category of the adjustment i.e. specifies that the category is used to identify whether the adjustment is related to charges/fees or if it is a generic adjustment. If the query parameter is not provided, the API will include adjustments linked to both of these categories in the response.

Allowed:

adjustmentTypeIndex

string

length between 3 and 3

^[0-9]{3,3}$

Index of the adjustment transaction type used to post the adjustment to merchant account and can be used to track in reporting. For a list of valid values, use Financial Adjustment API GET reference-data endpoint with query parameter "classification" equal to "adjustmentTypeIndex".

dateFrom

date

Common data object to pass the from date value when fetching records for a given date range. Accepted format YYYY-MM-DD. The date entered should not exceed the current institution posting date. The date entered should fall within the last 6 months from the current institution posting date. The provided value should not be greater than the 'dateTo' field. If both the 'dateFrom' and 'dateTo' fields are provided, the date range should not exceed 1 month. If either the 'dateFrom' or 'dateTo' field is provided, data will be extracted for that specific day only. If neither of the 'dateFrom' and 'dateTo' fields provided, data will be extracted for current institution posting date.

dateTo

date

Common data object to pass the to date value when fetching records for a given date range. Accepted format YYYY-MM-DD. The date entered should not exceed the current institution posting date. The date entered should fall within the last 6 months from the current institution posting date. The provided value should not be less than the 'dateFrom' field. If both the 'dateFrom' and 'dateTo' fields are provided, the date range should not exceed 1 month. If either the 'dateFrom' or 'dateTo' field is provided, data will be extracted for that specific day only. If neither of the 'dateFrom' and 'dateTo' fields provided, data will be extracted for current institution posting date.

limit

int32

1 to 1000

Defaults to 100

The number of items to return.

offset

int32

≥ 0

Defaults to 0

The number of items to skip before returning the results.

Headers

Trace-Id

string

required

An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.

Environment

string

required

^[a-zA-Z0-9_]{1,20}$

For test environment, specific test environment name should be passed (e.g. "bwu15"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value "prod" should be populated.

Institution-Number

string

required

length between 8 and 8

^[0-9]{8,8}$

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

Responses

200Success

400Bad request

401Unauthorised

403AccessForbidden

404Not found

500Internal server error

API Products

Point of Sale

Developer

Resources