# Private documentation Documentation ## Guides - [APIs](https://docs.fiserv.dev/private/docs/apis.md) - [Introduction](https://docs.fiserv.dev/private/docs/omnipay-acquirer-profile-intro.md) - [Access to the API](https://docs.fiserv.dev/private/docs/access-to-the-api-2.md) - [Constructing the API Call](https://docs.fiserv.dev/private/docs/constructing-the-api-call-2.md) - [API Integration Guidance](https://docs.fiserv.dev/private/docs/api-integration-2.md) - [Handling API Response Guidance](https://docs.fiserv.dev/private/docs/guidance-on-responses-1.md) - [Retrieve Reference Data](https://docs.fiserv.dev/private/docs/retrieve-reference-data.md) - [Retrieve Service Contracts](https://docs.fiserv.dev/private/docs/retrieve-service-contracts.md) - [Retrieve Merchant References](https://docs.fiserv.dev/private/docs/retrieve-merchant-references.md) - [Retrieve Institution Posting Date](https://docs.fiserv.dev/private/docs/retrieve-institution-posting-date.md) - [Retrieve Merchant Hierarchy](https://docs.fiserv.dev/private/docs/retrieve-merchant-hierarchy.md) - [Retrieve FX-Rates](https://docs.fiserv.dev/private/docs/retrieve-fx-rates.md) - [Retrieve Global Scheme Fees](https://docs.fiserv.dev/private/docs/retrieve-global-scheme-fees.md) - [Retrieve Address Categories](https://docs.fiserv.dev/private/docs/retrieve-address-categories.md) - [Retrieve Merchant Tariffs and Acquiring Services](https://docs.fiserv.dev/private/docs/retrieve-merchant-tariffs-and-acquiring-services.md) - [Retrieve Transaction Charges](https://docs.fiserv.dev/private/docs/retrieve-transaction-charges.md) - [Retrieve Tariffs](https://docs.fiserv.dev/private/docs/retrieve-tariffs.md) - [Retrieve Merchant Account Fees](https://docs.fiserv.dev/private/docs/retrieve-merchant-account-fees.md) - [Retrieve Auxiliary Charges](https://docs.fiserv.dev/private/docs/retrieve-auxiliary-charges.md) - [Retrieve Government Charges](https://docs.fiserv.dev/private/docs/retrieve-government-charges.md) - [Retrieve Accounts per Settlement Method and per Posting Tariff](https://docs.fiserv.dev/private/docs/retrieve-accounts-per-settlement-method-and-per-posting-tariff.md) - [Introduction](https://docs.fiserv.dev/private/docs/omnipay-boarding-intro.md) - [Access to the API](https://docs.fiserv.dev/private/docs/access-to-the-api.md) - [Constructing the API Call](https://docs.fiserv.dev/private/docs/constructing-the-api-call.md) - [API Integration Guidance](https://docs.fiserv.dev/private/docs/api-integration.md) - [Boarding API](https://docs.fiserv.dev/private/docs/boarding-api-1.md) - [Request Types](https://docs.fiserv.dev/private/docs/request-types.md) - [Introduction](https://docs.fiserv.dev/private/docs/omnipay-maintenance-intro.md) - [Access to Fiserv Omnipay API](https://docs.fiserv.dev/private/docs/access-to-the-api-1.md) - [Constructing the API Call](https://docs.fiserv.dev/private/docs/constructing-the-api-call-1.md) - [API Integration Guidance](https://docs.fiserv.dev/private/docs/api-integration-1.md) - [Handling API Response Guidance](https://docs.fiserv.dev/private/docs/guidence-on-responses.md) - [Merchant Accounts](https://docs.fiserv.dev/private/docs/merchant-accounts.md) - [Retrieve Merchant Accounts](https://docs.fiserv.dev/private/docs/merchant-accounts-1.md) - [Modify Merchant Accounts](https://docs.fiserv.dev/private/docs/update-merchant-accounts.md) - [Add Accounts](https://docs.fiserv.dev/private/docs/add-accounts.md) - [Account Fees](https://docs.fiserv.dev/private/docs/account-fees.md) - [Retrieve Account Fees](https://docs.fiserv.dev/private/docs/account-fees-1.md) - [Modify Future Dates Account Fees](https://docs.fiserv.dev/private/docs/modify-future-dates-account-fees.md) - [Delete Future Dated Account Fees](https://docs.fiserv.dev/private/docs/delete-future-dated-account-fees.md) - [Override Active Account Fees](https://docs.fiserv.dev/private/docs/override-active-account-fees.md) - [Expire Merchant Specific Account Fees](https://docs.fiserv.dev/private/docs/expire-merchant-specific-account-fees.md) - [Merchant Details](https://docs.fiserv.dev/private/docs/merchant-profile.md) - [Retrieve Merchant Details Information](https://docs.fiserv.dev/private/docs/retrieve-merchant-details-information.md) - [Add Merchant Contract Details](https://docs.fiserv.dev/private/docs/add-merchant-contract-details.md) - [Update Merchant Contract Details](https://docs.fiserv.dev/private/docs/update-merchant-contract-details.md) - [Delete Merchant Contract Details](https://docs.fiserv.dev/private/docs/delete-merchant-contract-details.md) - [Update Merchant Details Information](https://docs.fiserv.dev/private/docs/update-merchant-details-information.md) - [Retrieve Merchant Status - Scheduled](https://docs.fiserv.dev/private/docs/retrieve-merchant-status-scheduled.md) - [Add Merchant Status - Scheduled](https://docs.fiserv.dev/private/docs/add-merchant-status-scheduled.md) - [Modify Merchant Status - Scheduled](https://docs.fiserv.dev/private/docs/modify-merchant-status-scheduled.md) - [Delete Merchant Status - Scheduled](https://docs.fiserv.dev/private/docs/delete-merchant-status-scheduled.md) - [Modify Current Merchant Status](https://docs.fiserv.dev/private/docs/modify-current-merchant-status.md) - [FX Rate Margin](https://docs.fiserv.dev/private/docs/fx-rate-margin.md) - [Retrieve FX-Rate-Margin](https://docs.fiserv.dev/private/docs/fx-rate-margin-1.md) - [Add FX-Rate Margin](https://docs.fiserv.dev/private/docs/add-fx-rate-margin.md) - [Modify FX Rate Margin](https://docs.fiserv.dev/private/docs/update-fx-rate-margin.md) - [Transaction Charges](https://docs.fiserv.dev/private/docs/transaction-charges.md) - [Retrieve Transaction Charges](https://docs.fiserv.dev/private/docs/transaction-charges-1.md) - [Reprice Future Dated Transaction Charges](https://docs.fiserv.dev/private/docs/reprice-future-dated-transaction-charges.md) - [Delete Future Dated Transaction Charges](https://docs.fiserv.dev/private/docs/delete-future-dated-transaction-charges.md) - [Reprice Active Individual Transaction Charges](https://docs.fiserv.dev/private/docs/reprice-active-individual-transaction-charges.md) - [Clone Default Charges to Individual Charges](https://docs.fiserv.dev/private/docs/clone-default-charges-to-individual-charges.md) - [Expire Individual Transaction Charges](https://docs.fiserv.dev/private/docs/expire-individual-transaction-charges.md) - [Addresses](https://docs.fiserv.dev/private/docs/addresses-1.md) - [Retrieve Merchant Addresses](https://docs.fiserv.dev/private/docs/retrieve-merchant-addresses.md) - [Add Future Dated Addresses](https://docs.fiserv.dev/private/docs/add-future-dated-addresses.md) - [Modify Future Dated Addresses](https://docs.fiserv.dev/private/docs/modify-future-dated-addresses.md) - [Delete Future Dated Addresses](https://docs.fiserv.dev/private/docs/delete-future-dated-addresses.md) - [Merchant Services](https://docs.fiserv.dev/private/docs/merchant-services-1.md) - [Retrieve Acquiring Services](https://docs.fiserv.dev/private/docs/retrieve-acquiring-services.md) - [Add Merchant Acquiring Services](https://docs.fiserv.dev/private/docs/add-merchant-acquiring-services.md) - [Modify Merchant Services](https://docs.fiserv.dev/private/docs/modify-merchant-services.md) - [Merchant References](https://docs.fiserv.dev/private/docs/merchant-references-1.md) - [Retrieve Merchant References](https://docs.fiserv.dev/private/docs/retrieve-merchant-references-1.md) - [Add Merchant References](https://docs.fiserv.dev/private/docs/add-merchant-references.md) - [Modify Merchant References](https://docs.fiserv.dev/private/docs/modify-merchant-references.md) - [Delete Merchant References](https://docs.fiserv.dev/private/docs/delete-merchant-references.md) - [Payment Instructions](https://docs.fiserv.dev/private/docs/payment-instructions-1.md) - [Retrieve Payment Instructions](https://docs.fiserv.dev/private/docs/retrieve-payment-instructions.md) - [Add Payment Instructions](https://docs.fiserv.dev/private/docs/add-payment-instructions.md) - [Expire Payment Instructions](https://docs.fiserv.dev/private/docs/expire-payment-instructions.md) - [Merchant Properties](https://docs.fiserv.dev/private/docs/merchant-properties-1.md) - [Retrieve Merchant Properties](https://docs.fiserv.dev/private/docs/retrieve-merchant-properties.md) - [Add Merchant Properties](https://docs.fiserv.dev/private/docs/add-merchant-properties.md) - [Modify Merchant Properties](https://docs.fiserv.dev/private/docs/modify-merchant-properties.md) - [Delete Merchant Properties](https://docs.fiserv.dev/private/docs/delete-merchant-properties.md) - [Merchant Devices](https://docs.fiserv.dev/private/docs/merchant-devices-1.md) - [Retrieve Merchant Devices](https://docs.fiserv.dev/private/docs/retrieve-merchant-devices.md) - [Add Merchant Devices](https://docs.fiserv.dev/private/docs/add-merchant-devices.md) - [Modify Merchant Devices](https://docs.fiserv.dev/private/docs/modify-merchant-devices.md) - [Delete Merchant Devices](https://docs.fiserv.dev/private/docs/delete-merchant-devices.md) - [Split Payment Instructions](https://docs.fiserv.dev/private/docs/split-payment-instructions-1.md) - [Retrieve Split Payment Instructions](https://docs.fiserv.dev/private/docs/retrieve-split-payment-instructions.md) - [Add Split Payment Instructions](https://docs.fiserv.dev/private/docs/add-split-payment-instructions.md) - [Expire Split Payment Instructions](https://docs.fiserv.dev/private/docs/expire-split-payment-instructions.md) - [Quickstart](https://docs.fiserv.dev/private/docs/payment-advice.md) ## API Reference - [Retrieve Reference Data](https://docs.fiserv.dev/private/reference/getreferencedata.md): Some fields for merchant boarding or maintenance require (or accepts) a value from a predefined list configured per acquirer, any other value submitted is rejected. These fields are categorized as 'Classification' and are listed in the classification enum query parameter. The classification matches the actual field name from the Boarding/Maintenance API requests. This end point provides the consumer with the list of Classifications and it's respective values (description and index) that can be submitted. When no Classification is submitted, by default the API response will contain all possible Classifications and their respective values. - [Retrieve service contracts](https://docs.fiserv.dev/private/reference/getservicecontracts.md): This endpoint provides the user with the list of supported/configured Service Contracts for the acquirer. It returns the Service Contract index and the description. - [Retrieve merchant references](https://docs.fiserv.dev/private/reference/getmerchantreferences.md): Lists the valid references that can be associated to a merchant, indicating the allowed values configured per reference for the institution. If values are returned, then only the returned values are acceptable, otherwise any value is acceptable. - [Retrieve institution posting date](https://docs.fiserv.dev/private/reference/getinstitutionpostingdate.md): This endpoint provides the current institution posting date on the environment in YYYYMMDD format. - [Retrieve Merchant Hierarchy](https://docs.fiserv.dev/private/reference/getmerchanthierarchy.md): "This endpoint provides the merchant hierarchy details for an institution that are available on the Fiserv OmniPay database. To use this endpoint, you must include at least one of the following fields in the query parameters: 'internalMerchantId,' 'parentInternalMerchantId,' or 'externalMerchantId.' While these fields are not marked as mandatory, at least one of them is required." - [Retrieve FX Rates](https://docs.fiserv.dev/private/reference/getfxrate.md): "This endpoint provides the FX Rate details for an institution that are available on the Fiserv OmniPay database." - [Retrieve Global Scheme Fees](https://docs.fiserv.dev/private/reference/getglobalfees.md): "This endpoint provides the list of platform level scheme fees that are enabled for an institution." - [Retrieve Tariffs](https://docs.fiserv.dev/private/reference/get-servicecontracts-clienttariff.md): Returns the list of valid tariffs for the selected service contract which includes the Client Tariffs and Withhold Income and Withhold VAT tariffs. The client tariff will determine the default account fees and/or auxiliary charges and/or government charges configured to be assigned to the merchant. Withhold Income and WIthhold VAT tariff, where applicable, determines the merchant taxes applied to the merchant. - [Retrieve accounts per settlement method and posting tariff](https://docs.fiserv.dev/private/reference/get-servicecontracts-account-settlement.md): Retrieves a paginated list of valid account types and currency per settlement method and posting tariff for a service contract. The settlement method determines how the particular merchant account is settled. E.g. Daily based on the closing balance of the account via a SEPA funding file. The posting tariff determine where transactions are posted. E.g. All transaction gross amount will be posted to the "Payment Retail" account and all the associated transaction fees will be posted to the "Fee Collect" account. This endpoint can be used during boring and maintenance to find for a selected service contract the valid settlement methods, and for the settlement method the valid posting tariff as well as the valid account types and currencies for the combination of settlement method and posting tariff. By default all possible combinations are returned; the list can be filtered by settlement method and/or posting tariff. - [Retrieve transaction charges for services](https://docs.fiserv.dev/private/reference/get-servicecontracts-transaction-fees.md): Retrieves active default transaction charges per service contract (i.e. Default charges with the latest effective date compared to the current posting date). Results can be filtered by Merchant Tariff or Service ID. If Merchant Tariff or Service ID are not selected, charges for all services and tariffs are returned. List of active charges can include fees where the fee mode is set to suppressed. - [Retrieve government charges](https://docs.fiserv.dev/private/reference/get-servicecontracts-government-charges.md): Retrieves active government charges, e.g. VAT (i.e. default charges with the latest effective date compared to the current posting date). Results can be filtered per client tariff, if omitted all configured Client Tariff are returned. List of active charges can include fees where the fee mode is set to suppressed. - [Retrieve merchant account fees per client tariff](https://docs.fiserv.dev/private/reference/get-servicecontracts-account-fees.md): Retrieves active default account fees per service contract (i.e default charges with the latest effective date compared to the current posting date). Results can be filtered by Client Tariff, if omitted all configured Client Tariff are returned. List of active charges can include fees where the fee mode is set to suppressed. - [Retrieve auxiliary charges that may be applied to transactions](https://docs.fiserv.dev/private/reference/get-servicecontracts-auxiliary-charges.md): Retrieves default active auxiliary charges, e.g. Wire Fee, that can be assigned to a merchant (i.e default charges with the latest effective date compared to the current posting date). These are charges which are not related to a service. These charges are applicable to a merchant based on the Client Tariff assigned. Results can be filtered by Client Tariff, if omitted all configured Client Tariff are returned. List of active charges can include fees where the fee mode is set to suppressed. - [Retrieve address categories for the selected service contract index.](https://docs.fiserv.dev/private/reference/get-service-contracts-servicecontractindex-addresscategories.md): Returns a list of address categories valid for the service contract with a flag to indicate if the category is mandatory or not at a particular hiearchy level. - [Retrieve merchant tariff with associated services](https://docs.fiserv.dev/private/reference/get-service-contracts-service-tariffs.md): Returns a list of merchant tariffs and acquiring services for the selected service contract. Merchant Tariff determines the default transaction charges that will be assigned to the merchant. Acquiring Services is the bucket of similar card brands configured for the Institution to facilitate certain processes (e.g. Pricing) - [On-board a new merchant](https://docs.fiserv.dev/private/reference/onboardmerchant.md): By default it creates a merchant application with status Approved and processes the application so that a merchant is created in the OmniPay platform. Once the merchant is created they platform will accept transactions for the merchant as well as send the funding instructions for the merchant to be paid. The default create option can be overridden using the intent query param. - [Retrieve account fees](https://docs.fiserv.dev/private/reference/getmerchantaccountfees.md): Retrieves a paginated list of merchant account fees. By default only active fees are returned, the results can be fitered by fee status and fee model. - [Modify future dated account fees](https://docs.fiserv.dev/private/reference/updatemerchantaccountfees.md): This operation allows to update the fee mode, effective date, expiry date, fee percentage, fee base, fee minimum, fee maximum, trigger high value, trigger low value, trigger high volume and trigger low volume for one or more account fees. The fees to be updated are identified by record id number. Only individual fees whose effective date is in the future can be updated. Only passed fields will be updated, if a particular field should not be updated, it should not be passed. - [Override active account fees](https://docs.fiserv.dev/private/reference/insertmerchantaccountfees.md): This endpoint can be used to override one or more individual fees or default fees to individuals. In both cases the effective date should be in the future. The body of the request will include the list of fees that need to be overridden. Only the values to be overridden should be passed, fields that are not passed will inherit their original value. - [Delete future dated account fees](https://docs.fiserv.dev/private/reference/deletemerchantaccountfees.md): Deletes one or more merchant account fees. Only future dated merchant account fees can be deleted. - [Expire merchant individual account fees](https://docs.fiserv.dev/private/reference/suppressmerchantindividualaccountfees.md): For a merchant that is currently on individual charges, this operation will expire all those individual charges hence the merchant will start triggering default charges. - [Retrieve merchant accounts](https://docs.fiserv.dev/private/reference/getmerchantaccounts.md): Retrieves the list of merchant accounts for the merchant. The list can be filtered by account type and/or currency. - [Modify merchant accounts](https://docs.fiserv.dev/private/reference/updatemerchantaccounts.md): Supports updating of one or more accounts. The account(s) to be updated is identified by the internalAccountNumber. If a particular account type and currency combination is not yet defined for the merchant, use POST to create the merchant account - [Add merchant accounts](https://docs.fiserv.dev/private/reference/createmerchantaccounts.md): Adds one or more new account(s) to the merchant. The system will validate that the merchant currently don't have the combination of account type and currency passed on the request body. The new account type and currency should exist for the parent of the merchant otherwise an error returned. - [Retrieve merchant addresses](https://docs.fiserv.dev/private/reference/getmerchantaddress.md): Returns the addresses assigned to the merchant. Can be filtered by address category and status. By default, if no value is passed for the address category index, it returns all the address categories that are active for the merchant. The list can be filtered by address category and/or address status. - [Modify future effective addresses](https://docs.fiserv.dev/private/reference/putmerchantaddress.md): Allows updating of one or more existent merchant addresses. The record to be updated is identified by the category and effective date and all fields except for the ones identifying the record can be updated. - [Add future dated addresses](https://docs.fiserv.dev/private/reference/postmerchantaddress.md): Allows override of addresses and/or add new addresses A merchant address is identified by the effective date and address category. Address categories are used to define the purpose of the address. For example, the disputes address can be different from the merchant store location. - [Delete future dated addresses](https://docs.fiserv.dev/private/reference/deletemerchantaddresses.md): Deletes one or more merchant addresses. Only future dated merchant addresses can be deleted. - [Retrieve Merchant References](https://docs.fiserv.dev/private/reference/getmerchantreference.md): Retrieves the list of merchant references and its values assigned to a merchant. - [Modify Merchant References](https://docs.fiserv.dev/private/reference/updatemerchantreferencevalue.md): This operation allows to update one or more reference values for an existing merchant. - [Add Merchant References](https://docs.fiserv.dev/private/reference/addmerchantreferencevalue.md): This operation allows to add one or more merchant references to an existing merchant - [Delete Merchant references](https://docs.fiserv.dev/private/reference/deletemerchantreference.md): This operation allows to delete one or more merchant references assigned to a merchant. References to delete is identified by reference index. - [Retrieve merchant FX rate margins](https://docs.fiserv.dev/private/reference/getmerchantfxratemargins.md): Returns the list of fx margins for the merchant. - [Modify future dated merchant FX rate margins](https://docs.fiserv.dev/private/reference/updatemerchantfxratemargins.md): Provides means to update the rate margins, the record is identified by transaction currency, effective date and fee identifier. Updates are allowed only for one or more future dated (effective date later than current posting date) merchant FX rate margins. - [Add merchant FX rate margins](https://docs.fiserv.dev/private/reference/createmerchantfxratemargins.md): Adds one or more future effective (must have effective date later than current posting date) scheme FX margins to the merchant. - [Retrieve merchant details information](https://docs.fiserv.dev/private/reference/getmerchantprofile.md): Retrieves the Merchant Details for the provided merchant number - [Update merchant details information](https://docs.fiserv.dev/private/reference/putmerchantprofile.md): Update the Merchant Details information with immediate effect for the provided merchant number - [Update merchant contract details](https://docs.fiserv.dev/private/reference/updatemerchantcontractscheduled.md): Update the merchant future dated contract details. - [Add merchant contract details](https://docs.fiserv.dev/private/reference/addmerchantcontractscheduled.md): Add the merchant future dated contract details. - [Delete merchant contract details](https://docs.fiserv.dev/private/reference/deletemerchantcontract.md): Delete the merchant future dated contract details. - [Retrieve merchant status - scheduled](https://docs.fiserv.dev/private/reference/viewmerchantstatusscheduled.md): Retrieve scheduled request for changing merchant status. - [Modify merchant status - scheduled](https://docs.fiserv.dev/private/reference/modifymerchantstatusscheduled.md): Modify request of the scheduled merchant status change in future. - [Add merchant status - scheduled](https://docs.fiserv.dev/private/reference/addmerchantstatusscheduled.md): Add request to schedule merchant status change in future. - [Delete merchant status - scheduled](https://docs.fiserv.dev/private/reference/deletemerchantstatusscheduled.md): Deletes future dated scheduled request for merchant status change. - [Modify current merchant status](https://docs.fiserv.dev/private/reference/modifymerchantstatus.md): Modify merchant status with an immediate effect. - [Retrieves merchant transaction charges](https://docs.fiserv.dev/private/reference/getmerchantactivecharges.md): Retrieves a paginated list of transaction charges assigned to the merchant id. Can be filtered by charge status (default: ACTIVE) and the merchant's enabled acquiring service ( default: all). Filtering can be used together or independently. - [Reprice future dated merchant transaction charges](https://docs.fiserv.dev/private/reference/repricemerchantcharges.md): Reprice one or more future-effective individual merchant transaction charges. Records for the repricing are identified by record id number, which must be a valid future individual charge ( having effective date later than current posting date). This endpoint will update expiry date,fee mode,fee percentage,fee base,fee minimum and fee maximum - [Reprice active individual transaction charges](https://docs.fiserv.dev/private/reference/overridemerchantcharges.md): Reprice one or more active individual merchant transaction charges. Effective date for the new changes must be greater than posting date. Records for the repricing are identified by record id number, which must be a valid active individual charge. - [Delete future dated charges](https://docs.fiserv.dev/private/reference/deletemerchantindividualcharges.md): Deletes one or more future-effective transaction charges ( effective date later than current posting date). Records are identified by record id number. - [Expire merchant individual transaction charges](https://docs.fiserv.dev/private/reference/suppressmerchantindividualtransactioncharges.md): For a merchant that is currently on individual charges, this operation will expire all those individual charges hence the merchant will start triggering default charges. - [Clone default to individual charges](https://docs.fiserv.dev/private/reference/migratetoindividualcharges.md): For a merchant that is currently on default charges, this operation will create a complete set of individual charges whose values are equal to the default; this would allow the consumer to get the list of individual charges created so that the post and put operations can be done to customize the individual charges. - [Retrieve Acquiring Services](https://docs.fiserv.dev/private/reference/getmerchantservices.md): Retrieves details of acquiring services assigned to a merchant effective contract; if optional parameter service index passed in it will return details for the selected service index, otherwise it will return all (ACTIVE and CLOSED) acquiring services assigned to a merchant. - [Modify Merchant Services](https://docs.fiserv.dev/private/reference/updatemerchantservices.md): Operation allows to update details associated with an acquiring service assigned to a merchant effective contract. - [Add Merchant Acquiring Services](https://docs.fiserv.dev/private/reference/addacquiringservices.md): This operation allows to add one or more acquiring services to a memeber level merchant. - [Retrieve payment instructions](https://docs.fiserv.dev/private/reference/getpaymentinstructions.md): Retrieves a paginated list of payment instructions for a merchant. By default only active and future effective dated payment instructions are returned, the results can be fitered by account type, account currency code, instruction type and payment instruction status. - [Expire payment instructions](https://docs.fiserv.dev/private/reference/expirepaymentinstructions.md): This operation allows to expire one or more payment instructions assigned to a merchant. The payment instructions to be expired are identified by instruction id number. Only payment instructions with ACTIVE and FUTURE status can be expired. - [Add payment instructions](https://docs.fiserv.dev/private/reference/addpaymentinstructions.md): This endpoint can be used to add one or more payment instructions for a merchant. The start date should be in the future (i.e. greater than the currenct posting date of an institution). Refer static documentation for more information on validations involved against each fields. The body of the request will include the list of fields that can be included for each payment instruction. - [Retrieve Merchant Properties](https://docs.fiserv.dev/private/reference/getmerchantproperties.md): Retrieves the list of merchant properties and its values assigned to a merchant. - [Modify Merchant Properties Value](https://docs.fiserv.dev/private/reference/modifymerchantpropertiesvalue.md): This operation allows to update one or more merchant properties value for an existing merchant. - [Add Merchant Properties](https://docs.fiserv.dev/private/reference/addmerchantproperties.md): This operation allows to add one or more merchant properties to an existing merchant - [Delete Merchant Properties](https://docs.fiserv.dev/private/reference/deletemerchantproperties.md): This operation allows to delete one or more merchant properties assigned to a merchant. Properties to delete is identified by propertyIndex. - [Retrieve Merchant Devices](https://docs.fiserv.dev/private/reference/getmerchantdevices.md): Retrieves a paginated list of merchant devices for a merchant. - [Modify Merchant Devices](https://docs.fiserv.dev/private/reference/modifymerchantdevices.md): This operation allows to update one or more merchant device setup for an existing merchant. - [Add Merchant Devices](https://docs.fiserv.dev/private/reference/addmerchantdevices.md): This operation allows to add one or more merchant devices (details of the terminal associated with the merchant) to an existing merchant - [Delete Merchant Devices](https://docs.fiserv.dev/private/reference/deletemerchantdevices.md): This operation allows to delete one or more merchant devices assigned to a merchant. - [Retrieve split payment instructions](https://docs.fiserv.dev/private/reference/getsplitpaymentinstructions.md): Retrieves a paginated list of split payment instructions for a merchant. By default only active and future effective dated split payment instructions are returned, the results can be fitered by account type, account currency code, and split payment instruction status. - [Expire Split payment instructions](https://docs.fiserv.dev/private/reference/expiresplitpaymentinstructions.md): This operation allows to expire one or more split payment instructions assigned to a merchant. The split payment instructions to be expired are identified by instruction id number. Only split payment instructions with ACTIVE and FUTURE status can be expired. - [Add split payment instructions](https://docs.fiserv.dev/private/reference/addsplitpaymentinstructions.md): This endpoint can be used to add one or more split payment instructions for a merchant. The start date should be greater than or equal to the current posting date of an institution. Refer static documentation for more information on validations involved against each fields. The body of the request will include the list of fields that can be included for each split payment instruction. - [Modify Merchant Specific Pricing](https://docs.fiserv.dev/private/reference/updatetransactionandaccountfees.md): This operation enables the consumer to update their merchant-specific pricing setup, including transaction charges, account fees, or both. This endpoint can be utilized for the following purposes, 1. To expire all existing active and future effective dated merchant-specific charges and create new future effective dated merchant-specific charges. In this scenario, the user must provide a list of default recordIdNumbers from the current tariff assigned to the merchant along with the fee values that need to be overridden. 2. To expire all existing active and future effective dated merchant-specific charges and change the tariff assignment for the merchant, creating new future effective dated merchant-specific charges for the new tariff. In this case, the user must provide a list of default recordIdNumbers from the new tariff to be assigned to the merchant along with the fee values to be overridden. Note that if a merchant already has any future effective dated tariff change in place, adding another future effective tariff change is not permitted. - [Add Merchant Specific Promotional Pricing](https://docs.fiserv.dev/private/reference/addpromotionalpricing.md): This operation enables the consumer apply time bound promotional pricing including transaction charges, account fees, or both. Hence that pricing automatically reverts to the previous standard pricing when the promotion ends. Example scenarios: 1. Apply a temporary discounted price for a merchant on default or merchant-specific pricing; existing pricing resumes after the promotion. 2. Apply an additional promotion for a merchant that already has a promotion (same or different period); existing pricing resumes after the new promotion. Note that existing promotion is not modified until the effective date and expiry date for the new promotion overrides the existing promotion. Note that system clones the default recordIdNumbers and applies the overrides from the payload. Hence consumer must provide all default recordIdNumbers that they want to set to the different pricing. - [Submit a Payment Advice Notification Transaction](https://docs.fiserv.dev/private/reference/submit-payment-advice.md): Used for Payment Advice Notification Transaction. - [List Authorisations](https://docs.fiserv.dev/private/reference/getauthorisations.md): Return a list of all authorisations, restricted by your allianceCode, partnerCode or merchant ID (as appropriate) for the given datetime range. - [Retrieve a single authorisation](https://docs.fiserv.dev/private/reference/getauthorisationbyid.md): Returns single Authorisation for the given unique ID - [List the daily authorisation summaries](https://docs.fiserv.dev/private/reference/getauthorisationsummaries.md): Return a list of all authorisation summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID (as appropriate). - [List Transactions](https://docs.fiserv.dev/private/reference/gettransactions.md): Return a list of all transactions, restricted by your allianceCode, partnerCode or merchant ID (as appropriate) for the given datetime range. - [Retrieve a single transaction](https://docs.fiserv.dev/private/reference/gettransactionbyid.md): Returns single Transaction for the given unique ID - [List the daily transaction summaries](https://docs.fiserv.dev/private/reference/gettransactionsummaries.md): Return a list of all transaction summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID (as appropriate). - [List Fundings](https://docs.fiserv.dev/private/reference/getfundings.md): Return a list of all funding records, restricted by your allianceCode, partnerCode or merchant ID (as appropriate) for the given datetime range. - [Retrieve a single funding](https://docs.fiserv.dev/private/reference/getfundingbyid.md): Returns a single Funding for the given unique ID - [List funding details](https://docs.fiserv.dev/private/reference/getfundingdetails.md): Lists the Funding Detail rows for a specific Funding - [List the daily funding summaries](https://docs.fiserv.dev/private/reference/getfundingsummaries.md): Return a funding summary which contains a combined total of all fundings in the given date range, as well as daily summaries for the days within the given date range, restricted by your allianceCode, partnerCode or merchant ID (as appropriate). ## Changelog - [API - OmniPay Merchant Maintenance - 1.23.0](https://docs.fiserv.dev/private/changelog/api-omnipay-merchant-maintenance-1110.md) - [API - Payment Advice Service - Sandbox 1.0.0](https://docs.fiserv.dev/private/changelog/api-payment-advice-service-sandbox-100.md) - [API - Omnipay Merchant Boarding - 1.15.0](https://docs.fiserv.dev/private/changelog/merchant-boarding-api.md) - [API - OmniPay Acquirer Profile - 1.11.0](https://docs.fiserv.dev/private/changelog/api-payments-advice-service.md)