Create an adjustment
Create an adjustment for an existing merchant by making a POST API call to /post-adjustment endpoint in Financial Adjustment API.
Consumers must pass the following details as mandatory in the POST API call to successfully create an adjustment. The Adjustment Type Index can be extracted by making a GET API call to /retrieve-reference-data endpoint in Financial Adjustment API.
| OBJECT | DESCRIPTION | NOTE |
|---|---|---|
| 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. | Should be one of the valid value defined for an institution. |
| adjustmentTypeIndex | Index of the adjustment transaction type used to post the adjustment to merchant account and can be used to track in reporting. | Should be one of the valid value defined for an institution and mapped to the provided adjustment category. |
| internalMerchantId | Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment should be posted to. | Should be a valid active merchant exists for an institution. |
| amount | Adjustment amount. | Should follow the allowed format. |
| currency | Currency of the adjustment amount. ISO 4217 Alpha Currency code. | Should be one of the valid ISO 4217 format defined on OmniPay platform. |
| date | Indicates the transaction date related to the adjustment made. Format YYYYMMDD. | Should be provided in allowed format. |
Info
- Only one adjustment per API call is allowed.
- Fiserv OmniPay generates unique adjustment slip number upon successful staging and sent in API repsonse and Consumer should use this reference for future GET/MODIFY/CANCEL actions against this adjustment.
- Consumer cannot create any adjustment if the end of day batching process execution in progress. This process runs depends upon the institution configuration either one or more times in a day. In this case, Consumer must wait for the batching process to be completed and retry.
- If account number is provided, it must be in active status and assigned to the merchant.
- Provided amount must be greater than zero. The maximum allowed number of decimal places should align with the precision set for the 'currency' configured within OmniPay.
API Flow
Updated about 3 hours ago
