Update an adjustment

Modify a existing successfully stagged adjustment by making a PUT API call to /modify-adjustment endpoint in Financial Adjustment API.

Consumers must pass the following detail as mandatory in the PUT API call to successfully modify an adjustment.

OBJECTDESCRIPTIONNOTE
adjustmentSlipNumberUnique slip number generated for the adjustment. This is used to locate the adjustment and modify the data of the respective optional field details provided in the payloadShould be a valid value assigned to an adjustment.

📘

Info

  • Only one adjustment per API call is allowed.
  • Modify not allowed if adjustment status is 'Released' or 'Cancelled'.
  • If 'Error' status adjustment record has been modified, OmniPay change the status to 'Entered'
  • Modify not allowed if batching process running at that time. This process runs depends upon the institution configuration either one or more times in a day.
  • If account number is provided, it must be in active status and assigned to the merchant. 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.
  • 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.
  • Provided adjutsmentType should be one of the valid value defined for an institution and mapped to the provided adjustment category.
  • Provided adjustment category must be defined for an institution.
  • Creating adjustment to a merchant is permitted as long as the merchant is in an active status.

API Flow


Want a quick overview?