{"openapi":"3.0.1","info":{"title":"OmniPay Financial Adjustments API","description":"Welcome to OmniPay Financial Adjustments API. This API enables acquirers and payment facilitators to submit fees and adjustments to merchant accounts to be considered on the merchant payment or collection.\n\nChanges compared to version 1.1.0 \n- POST Adjustment API enhanced to support up to multiple adjustments in a single API call, replacing the previous limit of one adjustment per request\n- PUT endpoint updated to support multiple modification requests in a single API call.\n- DELETE endpoint updated to support multiple cancellation requests in a single API call.","contact":{"name":"OmniPay API team","email":"dl-emea-omnipay-api@fiserv.com"},"version":"1.2.0"},"servers":[{"url":"https://prod.emea.api.fiservapps.com/omnipay/financial/adjustments/v1.0","description":"Production"},{"url":"https://cat.emea.api.fiservapps.com/omnipay/financial/adjustments/v1.0","description":"Test"}],"tags":[{"name":"Endpoints"}],"paths":{"/post-adjustment":{"post":{"tags":["Endpoints"],"summary":"Create an Adjustment","description":"Submit fees and adjustments to merchant accounts as an array, to be applied as part of the merchant payment or collection. A maximum of 1,000 adjustments can be submitted in a single API call.","operationId":"post-adjustment","parameters":[{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},{"name":"Trace-Id","in":"header","description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}},{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Adjustment"}}}}},"responses":{"201":{"description":"Financial Adjustment Successfully entered.","headers":{"Trace-Id":{"description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdjustmentResponse"},"examples":{"createAnAdjustmentResponse":{"value":{"adjustmentSlipNumber":"12345678901","adjustmentStatus":"Entered","adjustmentCreatedDate":20240130}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"Api-Key":[]}]}},"/modify-adjustment":{"put":{"tags":["Endpoints"],"summary":"Modify an Adjustment","description":"Modify one or more previously created adjustments. Up to 1,000 adjustments can be submitted for modification in a single API call. Adjustments can only be modified prior to being picked up for processing. Modification is permitted only when the adjustment status is neither 'Released' nor 'Cancelled'.","operationId":"modify-adjustment","parameters":[{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},{"name":"Trace-Id","in":"header","description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}},{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModifyAdjustment"}}}}},"responses":{"204":{"description":"Financial Adjustment Modified Successfully.","headers":{"Trace-Id":{"description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"Api-Key":[]}]}},"/cancel-adjustment":{"delete":{"tags":["Endpoints"],"summary":"Cancel an Adjustment","description":"Cancel one or more adjustments in a single API call. Up to 1,000 adjustments can be submitted for cancellation in a single request. Adjustment cancellation is permitted only before the adjustments are picked up for processing. An adjustment can be cancelled only if its status is neither 'Released' nor 'Cancelled'.","operationId":"cancel-adjustment","parameters":[{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},{"name":"Trace-Id","in":"header","description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}},{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CancelAdjustment"}}}}},"responses":{"204":{"description":"Financial Adjustment Successfully cancelled.","headers":{"Trace-Id":{"description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"Api-Key":[]}]}},"/get-adjustments-staged":{"get":{"tags":["Endpoints"],"summary":"Retrieve Adjustments - Staged","description":"Retrieve list of adjustments that are staged.","operationId":"get-adjustments-staged","parameters":[{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},{"name":"Trace-Id","in":"header","description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}},{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}},{"name":"adjustmentSlipNumber","in":"query","description":"Unique identifier of the individual adjustment.","required":false,"schema":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","example":"12345678901"}},{"name":"batchSlipNumber","in":"query","description":"Unique identifier of the individual batch that has list of adjustments grouped.","required":false,"schema":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","example":"12345678901"}},{"name":"merchantId","in":"query","description":"Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment is posted to.","required":false,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"23456789"}},{"name":"adjustmentStatus","in":"query","description":"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\".","required":false,"schema":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3}$","type":"string","example":"001"}},{"name":"adjustmentCategory","in":"query","description":"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.","required":false,"schema":{"type":"string","example":"ADJUSTMENT","enum":["CHARGES_FEES","ADJUSTMENT"]}},{"name":"adjustmentTypeIndex","in":"query","description":"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\".","required":false,"schema":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3,3}$","type":"string","example":"839"}},{"name":"dateFrom","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},{"name":"dateTo","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},{"name":"limit","in":"query","description":"The number of items to return.","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},{"name":"offset","in":"query","description":"The number of items to skip before returning the results.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Success","headers":{"Trace-Id":{"description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"},"examples":{"OK":{"value":{"meta":{"paging":{"count":100,"totalPages":10,"currentOffset":1,"currentNumberOfRetrievedRecords":2,"maxLimit":2,"hasMoreRecords":true,"pageNumber":1},"sorting":{"sort":"name,-startDate"}},"data":[{"merchantId":"23456789","adjustmentSlipNumber":"12345678901","adjustmentStatus":"ENTERED","adjustmentCategory":"ADJUSTMENT","adjustmentType":{"index":"839","description":"Misc Merchant CR"},"adjustmentCreationDate":"20240424","accountNumber":"90000001001","amount":"100.12","currency":"EUR","date":"20240424","description":"Chargeback Fee CR","feeSequence":{"Code":"M09","description":"CLRG WRT OFF FEES"},"originalTransactionArn":"93240548754263421094323","quantity":"10","batchSlipNumber":"12345678999","createdBy":"Financial_Adjustment_API"},{"merchantId":"23456789","adjustmentSlipNumber":"12345458910","adjustmentStatus":"ENTERED","adjustmentCategory":"ADJUSTMENT","adjustmentType":{"index":"840","description":"Misc Merchant DR"},"adjustmentCreationDate":"20240425","accountNumber":"90000001002","amount":"10.12","currency":"EUR","date":"20240425","description":"Chargeback Fee DR","feeSequence":{"Code":"M09","description":"CLRG WRT OFF FEES"},"originalTransactionArn":"93240548754263421091113","quantity":"2","batchSlipNumber":"12345678119","createdBy":"Financial_Adjustment_API"}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"Api-Key":[]}]}},"/reference-data":{"get":{"tags":["Endpoints"],"summary":"Retrieve Reference Data","description":"Returns a list of valid values for the requested classification for an institution.","operationId":"get-reference-data","parameters":[{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},{"name":"Trace-Id","in":"header","description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}},{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}},{"name":"classification","in":"query","description":"This parameter can be used to filter the result for a particular classification. If ommited no filtering is done and all classifications with the corresponding values are extracted.","required":false,"schema":{"type":"string","enum":["adjustmentTypeIndex","feeSequenceCode","adjustmentStatusIndex"]}}],"responses":{"200":{"description":"Success","headers":{"Trace-Id":{"description":"An internal unique ID for each API request which can be used for diagnosing issues and corresponding with support.","required":true,"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"},"examples":{"multiplelist":{"value":{"meta":{"paging":{"count":6,"totalPages":1,"currentOffset":0,"currentNumberOfRetrievedRecords":6,"hasMoreRecords":false,"pageNumber":1},"sorting":{"sort":"classification,code"}},"data":[{"classification ":"adjustmentTypeIndex","code":"839","description":"Misc Merchant CR"},{"classification ":"adjustmentTypeIndex","id":"840","description":"Misc Merchant DR"},{"classification ":"feeSequenceCode","code":"M09","description":"CLRG WRT OFF FEES"},{"classification ":"feeSequenceCode","code":"T09","description":"Trmnl NOT returned"},{"classification ":"adjustmentStatusIndex","code":"001","description":"Entered"},{"classification ":"adjustmentStatusIndex","code":"008","description":"Released"}]}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/AuthenticationError"},"403":{"$ref":"#/components/responses/AccessForbidden"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"Api-Key":[]}]}}},"components":{"schemas":{"Adjustment":{"required":["adjustmentCategory","adjustmentTypeIndex","amount","currency","date","merchantId"],"type":"object","properties":{"adjustmentCategory":{"type":"string","description":"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.","example":"ADJUSTMENT","enum":["CHARGES_FEES","ADJUSTMENT"]},"adjustmentTypeIndex":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3,3}$","type":"string","description":"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\".","example":"839"},"merchantId":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","description":"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.","example":"23456789"},"accountNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"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.","example":"90000001001"},"amount":{"maxLength":18,"minLength":0,"pattern":"^[0-9\\.]{0,18}$","type":"string","description":"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.","example":"100.12"},"currency":{"maxLength":3,"minLength":3,"pattern":"^[a-zA-Z]{3,3}$","type":"string","description":"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.","example":"EUR"},"date":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Indicates the transaction date related to the adjustment made. Format YYYYMMDD. The date must not exceed the current institution posting date.","example":"20240424"},"description":{"maxLength":25,"minLength":0,"type":"string","description":"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.","example":"Chargeback Fee CR"},"feeSequenceCode":{"maxLength":3,"minLength":3,"pattern":"^[0-9A-Z]{3}$","type":"string","description":"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\".","example":"0Z1"},"originalTransactionArn":{"maxLength":23,"minLength":23,"pattern":"^[0-9]{23}$","type":"string","description":"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.","example":"93240548754263421094323"},"quantity":{"maxLength":6,"minLength":0,"pattern":"^[0-9]{0,6}$","type":"string","description":"Represents the count or quantity of transactions that are involved in the adjustment.","example":"10"}},"description":"Content for Creating Adjustments."},"ModifyAdjustment":{"required":["adjustmentSlipNumber"],"type":"object","properties":{"adjustmentSlipNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique slip number generated for the adjustment.","example":"12345678901"},"adjustmentCategory":{"type":"string","description":"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.","example":"ADJUSTMENT","enum":["CHARGES_FEES","ADJUSTMENT"]},"adjustmentTypeIndex":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3,3}$","type":"string","description":"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\".","example":"839"},"merchantId":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","description":"Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment should be posted to. Modifying adjustment to a merchant is permitted as long as the merchant is in an active status.","example":"23456789"},"accountNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique internal account number linked to the merchant account and account currency assigned to the merchant where the adjustment is posted to. Modifying 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.","example":"90000001001"},"amount":{"maxLength":18,"minLength":0,"pattern":"^[0-9\\.]{0,18}$","type":"string","description":"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.","example":"100.12"},"currency":{"maxLength":3,"minLength":3,"pattern":"^[a-zA-Z]{3,3}$","type":"string","description":"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.","example":"EUR"},"date":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Indicates the transaction date related to the adjustment made. Format YYYYMMDD. The date must not exceed the current system date.","example":"20240424"},"description":{"maxLength":25,"minLength":0,"type":"string","description":"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.","example":"Chargeback Fee CR"},"feeSequenceCode":{"maxLength":3,"minLength":3,"pattern":"^[0-9A-Z]{3}$","type":"string","description":"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 \"adjustmentTypeIndex\".","example":"0Z1"},"originalTransactionArn":{"maxLength":23,"minLength":23,"pattern":"^[0-9]{23}$","type":"string","description":"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.","example":"93240548754263421094323"},"quantity":{"maxLength":6,"minLength":0,"pattern":"^[0-9]{0,6}$","type":"string","description":"Represents the count or quantity of transactions that are involved in the adjustment.","example":"10"}},"description":"Content for modifying an Adjustment."},"CancelAdjustment":{"required":["adjustmentSlipNumber"],"type":"object","properties":{"adjustmentSlipNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique slip number generated for the adjustment.","example":"12345678901"}},"description":"Content for cancelling an Adjustment."},"AdjustmentResponse":{"title":"Adjustments Response Collection","type":"object","properties":{"adjustmentSlipNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique slip number generated for the adjustment.","example":"12345678901"},"adjustmentStatus":{"maxLength":23,"minLength":0,"type":"string","description":"Status of the adjustment.","example":"Entered"},"adjustmentCreationDate":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Indicates the date that the adjustment is created. Format YYYYMMDD.","example":"20240424"}}},"GetAdjustmentsStaged":{"title":"Get Adjustments","type":"object","properties":{"merchantId":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","description":"Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment is posted.","example":"23456789"},"adjustmentSlipNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique slip number generated for the adjustment.","example":"12345678901"},"adjustmentStatus":{"maxLength":23,"minLength":0,"type":"string","description":"Status of the adjustment.","example":"ENTERED"},"adjustmentCategory":{"type":"string","description":"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.","example":"ADJUSTMENT","enum":["CHARGES_FEES","ADJUSTMENT"]},"adjustmentType":{"$ref":"#/components/schemas/GetAdjustmentsStaged_adjustmentType"},"adjustmentCreationDate":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Indicates the date that the adjustment is created. Format YYYYMMDD.","example":"20240424"},"accountNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique internal account number linked to the merchant account and account currency assigned to the merchant where the adjustment is posted.","example":"90000001001"},"amount":{"maxLength":18,"minLength":0,"pattern":"^[0-9\\.]{0,18}$","type":"string","description":"Adjustment amount.","example":"100.12"},"currency":{"maxLength":3,"minLength":3,"pattern":"^[a-zA-Z]{3,3}$","type":"string","description":"Currency of the adjustment amount. ISO 4217 Alpha Currency code.","example":"EUR"},"date":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Indicates the transaction date related to the adjustment made. Format YYYYMMDD.","example":"20240424"},"description":{"maxLength":25,"minLength":0,"type":"string","description":"Adjustment description.","example":"Chargeback Fee CR"},"feeSequence":{"$ref":"#/components/schemas/GetAdjustmentsStaged_feeSequence"},"originalTransactionArn":{"maxLength":23,"minLength":23,"pattern":"^[0-9]{23}$","type":"string","description":"Acquirer reference number linked to the Original transaction.","example":"93240548754263421094323"},"quantity":{"maxLength":6,"minLength":0,"pattern":"^[0-9]{0,6}$","type":"string","description":"Represents the count or quantity of transactions that are involved in the adjustment.","example":"10"},"batchSlipNumber":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","description":"Unique slip number generated for the batch where the adjustment is grouped.","example":"12345678999"},"createdBy":{"maxLength":60,"minLength":0,"pattern":"^[a-zA-Z0-9À-ý_ \\.\\&\\,]{0,60}$","type":"string","description":"Source channel used to create the adjustment.","example":"Financial_Adjustment_API"},"lastUpdatedBy":{"maxLength":60,"minLength":0,"pattern":"^[a-zA-Z0-9À-ý_ \\.\\&\\,]{0,60}$","type":"string","description":"Source channel that last updated the adjustment.","example":"Financial_Adjustment_API"},"lastUpdatedDate":{"maxLength":8,"minLength":8,"pattern":"^([0-9]{4})(-?)(1[0-2]|0[1-9])\\2(3[01]|0[1-9]|[12][0-9])$","type":"string","description":"Date when the adjustment was last updated. Format YYYYMMDD.","example":"20240424"}}},"Error":{"title":"Error Response","required":["errors"],"type":"object","properties":{"errors":{"uniqueItems":false,"type":"array","items":{"$ref":"#/components/schemas/Error_errors"}}},"description":"This is the generic Error Response to be used for all Errors sent back in responses.","x-tags":["Meta"]},"referenceDataRecord":{"title":"Reference Data Record","type":"object","properties":{"classification":{"maxLength":20,"minLength":1,"type":"string","description":"The value of the classification match the index field for which the list of codes is applicable. ","example":"adjustmentTypeIndex","enum":["adjustmentTypeIndex","feeSequenceCode","adjustmentStatusIndex"]},"code":{"maxLength":8,"minLength":1,"pattern":"^[0-9A-Z]{1,8}$","type":"string","description":"Index/Code value."},"description":{"maxLength":100,"minLength":0,"type":"string","description":"Contains description associated to a code/index in English."}},"description":"The classification makes reference to a field. The code is the valid value for the field. The description is the meaning of the code."},"ResponseType":{"title":"ResponseType","type":"object","properties":{"meta":{"$ref":"#/components/schemas/MetaType"},"data":{"type":"array","description":"\"Contains the primary data to be returned as the API response. \n\nUse this object only when respnse type is an array.\n\nIt will not be returned in case of error.\"\n","items":{"type":"object"}},"errors":{"type":"array","description":"\"Contains one or more error messages and is mutually exclusive with the data item.\n\nThis will not be returned in success scenarios.\"\n","items":{"$ref":"#/components/schemas/ErrorType"}},"links":{"$ref":"#/components/schemas/LinksType"}},"description":"An API response.\n\nThe API response will be either a `SUCCESS` or an `ERROR`. A partial success or warning scenario will be treated as a Success with embedded messages in the meta data. A full success may not have messages.\n\nThe API response will contain at least one of the following top level members.\"\n","x-examples":{}},"MetaType":{"title":"MetaType","type":"object","properties":{"paging":{"$ref":"#/components/schemas/PagingMetaType"},"sorting":{"$ref":"#/components/schemas/SortingMetaType"},"messages":{"type":"array","description":"Messages related to request processing or response data - any additional information or warnings to be returned in the case of a successful API call.","items":{"$ref":"#/components/schemas/ErrorType"}}},"description":"Supplementary information about the data."},"PagingMetaType":{"title":"PagingMetaType","type":"object","properties":{"count":{"type":"integer","description":"Total number of records present in system which can be retrieved.","example":100},"totalPages":{"type":"integer","description":"Total number of pages with maximum limit taken into account.","example":10},"currentOffset":{"type":"integer","description":"Current offset used in request.","example":1},"currentNumberOfRetrievedRecords":{"type":"integer","description":"Current number of retrieved records.","example":10},"maxLimit":{"type":"integer","description":"Maximum limit of records that can be retrieved.","example":10},"hasMoreRecords":{"type":"boolean","description":"Indicates if there are more records available.","example":true},"pageNumber":{"type":"integer","description":"Current page number.","example":1}},"description":"Map containing pagination related information about data."},"SortingMetaType":{"title":"SortingMetaType","type":"object","properties":{"sort":{"type":"string","description":"Indicates the elements the current data is sorted with and the direction of sorting.","example":"name,-startDate"}},"description":"Map containing sorting related information about data."},"ErrorType":{"required":["code","title"],"type":"object","properties":{"id":{"type":"string","description":"Generated message identifier for particular request, helping to locate server logs.","example":"dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7"},"code":{"type":"string","description":"Machine readable, unique code of the message related to particular case within operation execution. For complete list of codes please refer to API portal, messages page.","example":"ACCOUNT_NUMBER_NOT_FOUND"},"title":{"type":"string","description":"Short description of the error. Not for displaying purposes.","example":"The authorization credentials required for this request are invalid."},"detail":{"type":"string","description":"Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes.","example":"SQLException found while trying to establish the connection with table TUKCDHN."},"source":{"$ref":"#/components/schemas/SourceType"}},"description":"Message details - additional operation execution information."},"SourceType":{"title":"SourceType","type":"object","properties":{"pointer":{"type":"string","description":"Indicates the element in the request document which caused the error.","example":"/dogs/name"},"parameter":{"type":"string","description":"Indicates which query parameter caused the error.","example":"type"},"header":{"type":"string","description":"Indicates which header caused the error.","example":"type"}},"description":"Object containing references to the source of the message."},"LinksType":{"title":"LinksType","type":"object","properties":{"self":{"type":"string","description":"The link to the primary resource being retrieved in the request.","example":"https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=3&limit=10"},"first":{"type":"string","description":"This is to provide the link to retrieve the first record/page. This SHOULD be used in case server provides pagination of the resource.","example":"https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=1&limit=10"},"last":{"type":"string","description":"This is to provide the link to retrieve the last record/page. This SHOULD be used in case server provides pagination of the resource.","example":"https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=10&limit=10"},"prev":{"type":"string","description":"This is to provide the link to retrieve the previous record/page. This SHOULD be used in case server provides pagination of the resource.","example":"https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=2&limit=10"},"next":{"type":"string","description":"This is to provide the link to retrieve the last record. This SHOULD be used in case server provides pagination of the resource","example":"https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=4&limit=10"}},"description":"Contains the links to retrieve the resources exposed as part of this API."},"inline_response_200":{"allOf":[{"$ref":"#/components/schemas/ResponseType"},{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetAdjustmentsStaged"}}}}]},"inline_response_200_1":{"allOf":[{"$ref":"#/components/schemas/ResponseType"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/referenceDataRecord"}}}}]},"GetAdjustmentsStaged_adjustmentType":{"type":"object","properties":{"index":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3,3}$","type":"string","description":"Index of the adjustment transaction type.","example":"839"},"description":{"maxLength":100,"minLength":0,"type":"string","description":"Description of the adjustment transaction type.","example":"Misc Merchant CR"}},"description":"Adjustment transaction type used to post the adjustment to merchant account and can be used to track in reporting."},"GetAdjustmentsStaged_feeSequence":{"type":"object","properties":{"Code":{"maxLength":3,"minLength":3,"pattern":"^[0-9A-Z]{3}$","type":"string","description":"Fee sequence code.","example":"M09"},"description":{"maxLength":100,"minLength":0,"type":"string","description":"Description of the fee sequence code.","example":"CLRG WRT OFF FEES"}},"description":"Fee Sequence that is linked to the adjustment."},"Error_errors":{"required":["detail","title"],"type":"object","properties":{"title":{"type":"string","description":"Readable error message that could be displayed in a UI."},"detail":{"type":"string","description":"Further description provided to give wider context into the error."},"source":{"type":"string","description":"Optional: Known source of error such as missing or invalid field in a request."}},"additionalProperties":false}},"responses":{"BadRequest":{"description":"Bad request","headers":{"Trace-Id":{"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Badrequest":{"value":{"errors":[{"title":"Bad Request - Incorrect or Missing Field","detail":"There is a validation error with fieldName. Field in body is mandatory. Please fix and repeat your request.","source":"fieldName"}]}}}}}},"AuthenticationError":{"description":"Unauthorised","headers":{"Trace-Id":{"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Unauthorised":{"value":{"errors":[{"title":"Authentication Error","detail":"No valid API key or credential has been provided in the request."}]}}}}}},"AccessForbidden":{"description":"AccessForbidden","headers":{"Trace-Id":{"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Forbidden":{"value":{"errors":[{"title":"Forbidden error","detail":"Access to the requested resource is forbidden."}]}}}}}},"ResourceNotFound":{"description":"Not found","headers":{"Trace-Id":{"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Notfound":{"value":{"errors":[{"title":"Resource Not Found","detail":"The requested resource cannot be found."}]}}}}}},"InternalServerError":{"description":"Internal server error","headers":{"Trace-Id":{"description":"An internal unique ID for this request which can be used for diagnosing issues and corresponding with support.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"Internalservererror":{"value":{"errors":[{"title":"Internal Server Error","detail":"Sorry, something has gone wrong at our end. If this persists please contact support and provide the value of your Trace-Id header."}]}}}}}}},"parameters":{"dateFrom":{"name":"dateFrom","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},"dateTo":{"name":"dateTo","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},"dateFrom1":{"name":"dateFrom","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},"dateTo1":{"name":"dateTo","in":"query","description":"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.","required":false,"style":"form","explode":false,"schema":{"type":"string","format":"date","example":"2019-06-30"}},"AdjustmentSlipNumber":{"name":"adjustmentSlipNumber","in":"query","description":"Unique identifier of the individual adjustment.","required":false,"schema":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","example":"12345678901"}},"BatchSlipNumber":{"name":"batchSlipNumber","in":"query","description":"Unique identifier of the individual batch that has list of adjustments grouped.","required":false,"schema":{"maxLength":11,"minLength":11,"pattern":"^[0-9]{11}$","type":"string","example":"12345678901"}},"AdjustmentCategory":{"name":"adjustmentCategory","in":"query","description":"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.","required":false,"schema":{"type":"string","example":"ADJUSTMENT","enum":["CHARGES_FEES","ADJUSTMENT"]}},"AdjustmentType":{"name":"adjustmentTypeIndex","in":"query","description":"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\".","required":false,"schema":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3,3}$","type":"string","example":"839"}},"MerchantId":{"name":"merchantId","in":"query","description":"Unique OmniPay 8-digit internal merchant number assigned to the merchant where the adjustment is posted to.","required":false,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"23456789"}},"AdjustmentStatus":{"name":"adjustmentStatus","in":"query","description":"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\".","required":false,"schema":{"maxLength":3,"minLength":3,"pattern":"^[0-9]{3}$","type":"string","example":"001"}},"OffsetParam":{"name":"offset","in":"query","description":"The number of items to skip before returning the results.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},"LimitParam":{"name":"limit","in":"query","description":"The number of items to return.","required":false,"schema":{"maximum":1000,"minimum":1,"type":"integer","format":"int32","default":100}},"Content-Type":{"name":"Content-Type","in":"header","description":"Standard HTTP Header; Represents the format of the payload being provided in the request. This must be set to application/json and applicable for POST/PATCH.","required":true,"schema":{"type":"string","enum":["application/json","application/json;charset=UTF-8"]}},"Environment":{"name":"Environment","in":"header","description":"For test environment, specific test environment name should be passed (e.g. \"bwu15\"). Contact Fiserv OmniPay Project team to get confirmation on the test environment to be used. For production, value \"prod\" should be populated.","required":true,"schema":{"pattern":"^[a-zA-Z0-9_]{1,20}$","type":"string"}},"Institution-Number":{"name":"Institution-Number","in":"header","description":"Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.","required":true,"schema":{"maxLength":8,"minLength":8,"pattern":"^[0-9]{8,8}$","type":"string","example":"00000099"}}},"securitySchemes":{"Api-Key":{"type":"apiKey","description":"Your API key from the Developer Platform.","name":"Api-Key","in":"header"}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}