The following is an overview of the items described in this documentation:

  1. The API flow diagram.
  2. The API endpoints that have been exposed.
  3. The environments that are available to support client integration.

Financial Adjustment API Flow


Financial Adjustment API Endpoints

Financial Adjustment API will have the below endpoints:

ENDPOINT #ENDPOINT NAMEDESCRIPTIONENDPOINT
1Create an AdjustmentRequested by clients to create financial adjustment for a merchantomnipay/financial/adjustments/v1.0/post-adjustment
2Modify an AdjustmentRequested by clients to modify financial adjustment for a merchant prior to be picked for processingomnipay/financial/adjustments/v1.0/modify-adjustment
3Cancel an AdjustmentRequested by clients to cancel financial adjustment for a merchant prior to be picked for processingomnipay/financial/adjustments/v1.0/cancel-adjustment
4Retrieve Adjustments - StagedRequested by clients to retrieve financial adjustments that are successfully stagedomnipay/financial/adjustments/v1.0/get-adjustments-staged
5Retrieve Reference DataRequested by clients to retrieve list of valid values for adjustmentTypeIndex, feeSequenceCode, adjustmentStatusIndex fieldsomnipay/financial/adjustments/v1.0/reference-data

Environments

S.No #NAMEURLENVIRONMENT
1cathttps://cat.emea.api.fiservapps.com/{ENDPOINT}UAT Test environment
2prodhttps://prod.emea.api.fiservapps.com/{ENDPOINT}Production environment

Want a quick overview?