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. To enable consumer usage, the adjustment category must be defined for an institution.

Index of the adjustment transaction type under respective adjustment category 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".

Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment should be posted to. Creating adjustment to a merchant is permitted as long as the merchant is in an active status.

Unique internal account number linked to the merchant account and account currency assigned to the merchant where the adjustment is posted to. Creating adjustment to a merchant account is permitted as long as the account is in an active status. If provided, the adjustment will be posted to this merchant account. If not provided, the adjustment will be posted to the respective merchant account and account currency based on the posting instructions configured to the merchant. For list of valid values, use GET accounts endpoint in Merchant Maintenance API.

Adjustment amount. The 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.

Currency of the adjustment amount. ISO 4217 Alpha Currency code. Note that if the currency of the adjustment amount provided differs from the currency of the merchant account it is posted to, currency conversion will be conducted (at the time of end of cycle posting process) based on the FX rate rules established at the institution level.

Indicates the transaction date related to the adjustment made. Format YYYYMMDD. The date must not exceed the current system date.

Adjustment description. If the first 2 characters are passed as “##”, the description will be suffixed in the “Transaction Type” field in reporting. There is no pattern defined for this field. UTF8 characters (extended ASCII characters) are supported for this field. Maximum length of this field is defined in bytes and special character of any extended ASCII character can be more than 1 byte for each character. Consumer should consider number of bytes for maximum length determination. For example, if consume wants to provide three 2-bytes ASCII character, then actual length of the provided data is 6, not 3.

Fee sequence code that will be linked to the adjustment. For a list of valid values, use Financial Adjustment API GET reference-data endpoint with query parameter "classification" equal to "feeSequenceCode".

Acquirer reference number linked to the Original transaction. For certain acquirers, this field is required if the provided fee sequence code is linked to chargebacks.

Represents the count or quantity of transactions that are involved in the adjustment.

Optional security header. Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

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.