Retrieve Adjustments

Retrieve list of adjustments that are stagged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length between 11 and 11

Unique identifier of the individual adjustment.

string
length between 11 and 11

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

string
length between 8 and 8

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

string
length between 3 and 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".

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.

Allowed:
string
length between 3 and 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".

date

Common data object to pass the from date value when fetching records for a given date range. Accepted format YYYY-MM-DD. This parameter can be used in Path or Query.

date

Common data object to pass the to date value when fetching records for a given date range. Accepted format YYYY-MM-DD. This parameter can be used in Path or Query.

int32
1 to 1000
Defaults to 100

The number of items to return.

int32
≥ 0
Defaults to 0

The number of items to skip before returning the results.

Headers
string
length between 8 and 8

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant. If a consumer is granted access to this API for multiple institutions, this field must be populated. If access is for only one institution, the API will automatically determine this value, making it optional for the client.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Want a quick overview?