List adjustments
Retrieve a list of financial adjustments that are staged by making a GET API call to /get-adjustments-staged endpoint in Financial Adjustment API.
User will be able to retrieve data up to 6 months in the past via API. For more than 6 months older data, please reach out to OmniPay Client Support to retreive data.
User will be able to filter the financial adjustments using following query parameters by passing in API request for every GET API call to /get-adjustments-staged endpoint:
| OBJECT | DESCRIPTION |
|---|---|
| adjustmentCategory | 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. |
| adjustmenSlipNumber | Unique identifier of the individual adjustment. |
| adjustmentStatus | 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". |
| adjustmentTypeIndex | 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". |
| batchSlipNumber | Unique identifier of the individual batch that has list of adjustments grouped. |
| merchantId | Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment should be posted to. |
| dateFrom | 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 | 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 | The number of items to return. Refer 'Guidance on Responses' section to know how to use this field. |
| offset | The number of items to skip before returning the results. Refer 'Guidance on Responses' section to know how to use this field. |
API Flow
Updated about 3 hours ago
