--- title: "Update merchant details information" method: PUT path: "/merchant-details" tags: ["Merchant Details"] --- # Update merchant details information `PUT /merchant-details` Update the Merchant Details information with immediate effect for the provided merchant number ## Headers - `Content-Type` 'application/json' | 'application/json;charset=UTF-8', required - `FSV-Interaction-Id` string, required - `Environment` string, required - `Institution-Number` string, required - `Internal-Merchant-Id` string, required ## Request body - MerchantUpdateDetails — Update Merchant Details - `requiredDetails` MerchantUpdateDetailsRequiredDetails - `externalMerchantId` string — Merchant number to be used throughout the authorization and clearing cycle. - `tradeName` string — Merchant Trade Name. 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. - `companyName` string — Merchant's legal company name. 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. - `legalForm` string — Company entity type for information purposes only, no impact to transaction processing. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal legalFormIndex when creating or editing an existing merchant profile. - `languageIndex` string — Merchant language for information purposes only, no impact to transaction processing. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal languageIndex when creating or editing an existing merchant profile. - `mcciso` string — Merchant category code (ISO 18245 ), depending on the client region setting this value may be used for clearing transactions to the scheme. - `eCommerceIndCode` 'TRADITIONAL_ONLY' | 'ECOMMERCE_ONLY' | 'BOTH' — Field is used for the quarterly stats which are sent to the schemes. - `residentStatusCode` 'NA' | 'RESIDENT' | 'NON_RESIDENT' — The residency status of the merchant. Indicates whether the merchant is a resident or non-resident for information purposes only, no impact to transaction processing. - `accountOfficerIndex` string — Merchant account officer; the possible values can be customized per institution, use 000=N/A if not relevant for the institution. For a list of valid codes use Acquirer Profile API get reference_data endpoint with query parameter classification equal accountOfficerIndex when creating or editing an existing merchant profile. - `retailerClassificationCode` string — An RCC identifies the type of business performed within a merchant outlet. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal retailerclassification when creating or editing an existing merchant profile. - `branchIndex` string — Merchant branch; the possible values can be customized per institution, use 000=N/A if not relevant for the institution. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal branchIndex when creating or editing an existing merchant profile. - `optionalDetails` MerchantUpdateDetailsOptionalDetails - `registrationNo` string — The merchant registration number is a field that is conditional based on the configuration setup of an institution. By default, this field is mandatory, but it can be made optional at the institution level. If the field is provided in the payload, it must have a minimum length of 5 characters. Note that this value will be encrypted before storage, as it is considered PII data. To ensure proper encryption, a minimum length of 5 characters is required. - `vatRegNo` string — Merchant registered value added tax number (VAT) . Note this value will be encrypted prior to be stored as this is considered PII data. - `secondaryTaxId` string — Additional tax ID used by Canadian based merchants with provinces supporting two separate taxes (federal and provincial tax). If provided, then the value must be Upper Case Alphanumeric and minimum of 5 character length. Note this value will be encrypted prior to be stored as this is considered PII data. To suppport encryption process, minimum of 5 character length must be provided. If a user want to delete the value for this field as part of merchant maintenance API i.e. null value, then it is allowed to pass the empty string. - `contractReference` string — Application contract reference number. This is a free format field for information purpose only. - `bankReference` string — Merchant bank reference number. This is a free format field, where the value can be defined by the merchant/acquirer, information purposes only, no impact to transaction processing - `dynamicPricing` boolean — Indicate if the merchant uses dynamic pricing - `merchantGradeIndex` string — Merchant grouping by business type and volume. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal merchantGradeIndex when creating or editing an existing merchant profile. - `prosaDeterminant` string — Unique identifier of the business by the Internetwork, used by PROSA to process transactions. If a merchant have PROSA acquiring service assigned, then this field is mandatory. Spaces allowed only if a merchant does not have the PROSA acquiring service assigned. - `prosaBDUNumber` string — Local number to identify Mexican merchant regulated by Mexican authorities, handled by PROSA. If a merchant have PROSA acquiring service assigned, then this field is mandatory. Zeroes allowed only if a merchant does not have PROSA acquiring service assigned. - `signerDateOfBirth` string — Indicates Date of Birth of the Seller's Authorized Signer. The Seller is a legal representative of the business from merchant side. The format is YYYYMMDD. If a merchant have AMEX Optblue acquiring service assigned, then this field is mandatory. Zeroes allowed only if merchant does not have AMEX Optblue acquiring service assigned. - `merchantLongName` string — Merchant's legal company name. If consumer wants to store more than 35 characters of the company name, then it can be stored in this field. There is no pattern defined for this field. Any extended ASCII characters contain 2 bytes, and UTF8 characters (which include extended ASCII characters) are supported in this field. The maximum length of this field is defined in bytes, and special characters of any extended ASCII character can be more than 1 byte for each character. Consumers should take the number of bytes into consideration when determining the maximum length. For example, if a consumer wants to provide three 2-byte ASCII characters, the actual length of the provided data is 6, not 3. - `mcpRateType` string — This field indicates the type of rate to be used for Multi-Currency Pricing transactions. The value in this field influences the currency conversion applied to merchant funding, especially when OpenFX functionality is enabled for an institution with the necessary FX rate rule setup. If the field not populated in merchant boarding payload, then OmniPay default the value to 'E'(default). For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter classification equal to mcpRateType. - `domesticMcc` string — A domestic MCC in Spain identifies a business's type of goods or services within the country and influences interchange fees, data analysis, and overall payment processing for card transactions. In OmniPay, this data is stored exclusively for reporting purposes and is required only for member-level merchants (Country code as Spain) of specific institutions if the institution's configuration is set up accordingly. In Maintenance, if user wants to update this field to blank, then empty string must be passed. - `contracts` MerchantUpdateContractDetails — Update Merchant Contract Details - `paymentMethodIndex` string — Institution defined value related to a specific payment interface. Default to spaces when no values provided. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal paymentMethodIndex when creating or editing an existing merchant profile. - `protectAgainstFXChange` boolean — Flag to indicate if the merchant is protected against currency fluctuations on the event the transaction is disputed and the transaction currency is different to the merchant funding currency. - `clientRegionIndex` string — The selected client region will determine how the transactions are settled to the scheme. For a list of valid regions use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal clientRegionIndex when creating or editing an existing merchant profile. - `reclassBillbackIndicatorCode` 'NA' | 'NO_BILLBACK' | 'AUT_BILLBACK_DR' | 'AUT_BILLBACK_ALL' | 'MANUAL_BILLBACK' — Indicator to pass the Reclass fee to the merchant. Reclass Fees can only be passed to the merchant when configured for the Institution. - `withholdIncomeTariffIndex` string — The withhold income tariff id for the institution. For a list of valid codes use Acquirer Profile API call GET tariff endpont when creating or editing an existing merchant profile. The corresponding valid tariff will have tariffType= WITHHOLD_INCOME_TARIFF. - `withholdVatTariffIndex` string — The withhold vat tariff id for the institution. For a list of valid codes use Acquirer Profile API GET tariff endpont when creating or editing an existing merchant profile. - `regionalTaxIndex` string — Indicator if regional tax to be generated or not. - `location` MerchantUpdateDetailsLocation - `country` string — ISO-3166 alpha country code representing the country the merchant is located in, the values are restricted based on institutions configuration. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal countryCode when creating or editing an existing merchant profile. - `state` string — Code representing the state the merchant is located in. If the country selected is United States, Canada or Italy, this field is mandatory. 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. - `cityUrl` string — Merchant city for physical merchants, URL for ecommerce merchants. 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. - `telephone` string — Merchant telephone number. The format should be 'Country code' (numeric value) followed by '-' followed by actual phone number (numeric value). For Merchant Maintenance API, empty string can be passed if a user wants to delete the value. - `zip` string — Merchant zip/postcode. If a visa-related 'serviceIndex' is assigned to a merchant and the merchant's country is the USA, the allowed value should be a 5-digit number, except for 00000. If a Mastercard/Europay-related 'serviceIndex' is assigned to a merchant, the allowed value should match the pattern '[a-zA-Z0-9 ]', except for 99999. If all of these scheme-related 'serviceIndex' values are assigned to the merchant, the provided value must satisfy all of these validation criteria. - `street` string — Merchant street. 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. - `serviceTelNo` string — Merchant service telephone number - `countyIndex` string — County id where the merchant is located. As per Institution configuration. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal countyIndex when creating or editing an existing merchant profile. - `fax` string — Merchant fax number - `salutation` 'THE_DIRECTOR' | 'THE_OWNER' | 'THE_PROPRIETOR' — Title to be assigned to the main contact of the merchant. - `regionOverrideFlag` boolean — Flag relevant to institutions processing Payment Facilitator Single MID Model for user defined regions. If the value passed as empty string, then default value 'false' is considered. - `municipalityIndex` string — Municipality id where the merchant is located. As per Institution configuration. For a list of valid codes use Acquirer Profile API GET reference-data endpoint with query parameter classification equal municipalityIndex when creating or editing an existing merchant profile. - `url` string — A valid URL/website address of the e-commerce merchant. Applicable for MasterCard e-commerce transactions. If not provided at the transaction level, OmniPay will retrieve it from the merchant profile and include it in the scheme clearing file and respective merchant profile reporting. However, if this optional field is provided, it cannot consist solely of spaces or zeros. - `schemeDetails` MerchantUpdateDetailsSchemeDetails - `crossBorderFeeCode` 'NONE' | 'MASTERCARD' | 'VISA' | 'BOTH' — Indicates whether a merchant is liable for corss boder fees for MasterCard, Visa both. - `masterCardIPQualificationCode` 'NA' | 'CHARITY' | 'MASTERCARD_AID' | 'GAMBLING' — The MasterCard interchange program qualification lists the interchange programs for MasterCard. - `masterCardIPValue` string — The MasterCard interchange program value field assigned by MasterCard for the corresponding interchange program. - `visaIPQualificationCode` 'NA' | 'VAU_VALIDATED' | 'VISA_SPEND_QUALF_IND' | 'VISA_EPS' | 'VISA_MVV_PROGRAM' | 'LOW_VALUE_PAYMENTS' | 'CHARITY' | 'SG_EZ_LINK' | 'SG_STRATGC_SUPERMRKT' | 'SG_STRATGC_GOVERNMNT' | 'BILL_PAY' | 'VISA_INDIAN_FUND_TXN' | 'HK_STRATGC_GOV' | 'SG_STRATGC_ULITITIES' | 'SG_STRATGC_VISA_BPAY' | 'TH_STRATGC_4' | 'TH_STRATGC_5' | 'TH_STRATGC_8' | 'SMALL_MERCHANT' | 'CPS_RETAIL' | 'VISA_MVV_PROGRAM_CLR' | 'INDIA_PM_CARES' | 'VISA_MPP_UK' | 'VISA_IND_BPSP_STRATEGIC' | 'VISA_M2M_UK' | 'VISA_M2M_MPP_UK' | 'TRANCHE_2' | 'TRANCHE_3' — The Visa interchange program qualification lists the possible interchange program for Visa. - `visaIPValue` string — This Visa interchange program value field is assigned by Visa for the corresponding interchange program. - `paymentLowValue` boolean — Flag to determine if the merchant is eligible to qualify for UK domestic low value E-Commerce. - `cbdipVisaSmiCode` string — Single merchant identifier (SMI) provided by Visa when merchant is registered with cross border interchange program CBDIP - `mcPaymentFacilitatorId` string — MasterCard registered payment facilitator id for merchants processing PF transactions - `visaPaymentFacilitatorId` string — Visa registered payment facilitator id for merchants processing PF transactions - `mcIndependentSalesOrgId` string — MasterCard registered ISO for merchants processing ISO transactions - `visaCanIasfFee` boolean — Indicator if Visa international acquirer service Fee (IASF) cross border fee applies on all transactions assessed in Canada for non canadian issued cards. - `viLacFeeCode` 'NA' | 'VISA_LAC_IA_FEE' | 'VISA_LAC_ISA_FEE' | 'BOTH_LAC_FEES' — Indicator for which VISA cross border fees (ISA, IA or both) in the Latin America and Caribbean (LAC) to be applied. - `mcLacFeeCode` 'NA' | 'MC_LAC_CB' | 'MC_LAC_CB_REBATE' | 'MC_LAC_BOTH' — Indicator for which MC cross border fees (CB , CB Rebate or both) in the Latin America and Caribbean (LAC) to be applied. - `mcAbvFeeInd` boolean — Indicator if MasterCard acquirer brand volume fee is applicable for the merchant - `visaEuFeeIndCode` 'NEITHER' | 'VISA_IA_FEE' | 'VISA_ECOM_FEE' | 'BOTH_VISA_EU_FEES' — Indicator for which EU fee to be charged for the merchant located in Europe. VISA_IA_FEE indicates fee to be charged for international non-Ecommerce transactions and VISA_ECOM_FEE indicates fee to be charged for international Ecommerce transactions. - `mcIntlEcomFee` boolean — Indicates the enabling of the MasterCard International Ecommerce Fee, available options depends on the institution configuration. - `viUsApIafFee` string — Indicator for which VISA fees (AP IAF, US IAF, both or neither) to be enabled, available options depends on the institution configuration. For a list of valid codes use Acquirer Profile API GET reference-data endpoint with query parameter classification equal viUsApIafFee when creating or editing an existing merchant profile. - `pagobancomatIndex` string — Indicates when Pagobancomat transactions are flagged as bill payment. Available options depends on the institution configuration. For a list of valid codes use Acquirer Profile API get reference_data endpoint with query parameter classification equal pagobancomatIndex when creating or editing an existing merchant profile. - `globalTravelB2BFeeInd` string — Indicates whether the MasterCard Global Wholesale Travel Transaction Program B2B Fee should be charged to the merchant. For a list of valid codes use Acquirer Profile API get reference-data endpoint with query parameter classification equal globalTravelB2BFeeInd when creating or editing an existing merchant profile. - `mcCnpMotoFee` 'NO_FEE' | 'MC_CNP_FEE_ONLY' | 'MC_MOTO_FEE_ONLY' | 'BOTH_MC_CNP_&_MOTO_FEE' — It supports the activation of the MC scheme fee. - `mcPifFeeInd` boolean — Indicator whether the MasterCard Processing Integrity Fee is applicable for the merchant. If the value passed as empty string, then default value 'false' is considered. - `dinersIntesCode` string — Unique identifier assigned by Diners to merchants who have agreement for preferred interchange rates. This field is cleared to scheme. (Value can be same across multiple MIDs). If provided, then it must be minimum of 3-digit numeric value and Maximum of 4-digit numeric value. The field is defined as alphanumeric because to allow user to pass empty string in Merchant Maintenance API only to delete the value when in case merchant come out of registration with Diners for this special interchange program. - `amexModelIndex` string — Flag to determine which AMEX clearing model to be applied for AMEX transactions. For merchant boarding API, if the object is not provided or provided with value '000', then CAPN AMEX clearing model is defaulted if AMEX acquiring service is enabled for a merchant. For a list of valid codes use Acquirer Profile API get reference_data end-point with query parameter classification equal amexModelIndex. Note that if a value '001' (AMEX GNS) provided for this field, then there will be a cross validation applied against valid Client reference Type '201---Amex' assigned to the merchant with 10-digit AMEX SE number populated as client reference value. - `merchantCountryOfOrigin` string — Alpha country code representing the merchant country of origin for government controlled merchants. For eg. Merchant (Indian Embassy) located in Ireland should have value populated as "IND" (India) in this field. If the field is provided with 3 spaces then default value N/A will be assigned. This is conditional field i.e. list of merchant category codes (ISO numeric codes) for government-controlled merchants are added to the configuration of certain institutions. Merchants boarded under these institutions and falling under these merchant category codes (value in 'mcciso' field within the 'requiredDetails' object) must ensure that the 'merchantCountryOfOrigin' field contains a valid value. - `merchantSizeIndex` string — Flag to determine volume of transactions for the merchant. Depending on the region this information can be used for assessing the interchange. For merchant boarding API, if the object is not provided, then system will default to index '003' (null value). - `mvi` 'NOT_ELIGIBLE' | 'VISA_ELIGIBLE' — Flag to identify if the merchant participates in the Visa Merchant Volume Indicator (MVI) programme or not. If provided, then it should be one of the valid value. Merchants can be flagged as MVI participant (via Merchant Maintenance) only after successful boarding. - `globalFees` GlobalFees[] — Provide list of scheme fees to be enabled or disabled for a merchant. These fees must be pre-defined as platform level fees and enabled for an institution on OmniPay. - `feeIndex` string, required — Index value of the platform level fee. Valid values are depends on the institution configuration. For a list of valid values use Acquirer Profile API get global_fees endpoint. - `feeMode` boolean, required — Flag to indicate if the fee is applicable for a merchant. - `cardOrganization` string, required — The index value indicating the card scheme to which the platform level fee is associated. Valid values are depends on the institution configuration. For a list of valid values use Acquirer Profile API get global_fees endpoint. - `upiIPQualificationCode` string — Indicates the code that qualifies merchant transactions for the preferred interchange rates established between UPI and the merchants. The valid codes are predefined in OmniPay for each type of interchange rate that OmniPay supports. This code is not cleared to UPI and can be used across multiple merchants. - `marketPlaceId` string — Unique identifier assigned to a merchant or business within the Visa MarketPlace platform. It helps in identifying specific merchants for various purposes, including reporting, analytics, and promotional activities associated with Visa's offerings. This field value is included in the scheme clearing file if no override is provided during the presentment transaction. - `stagedDigitalWalletId` string — The Staged Digital Wallet ID is a unique identifier assigned by the Visa Network to digital wallet transactions that involve multiple stages to complete the transaction. It is used to track and manage these transactions, ensuring accurate processing once the wallet is activated. This field value is included in the scheme clearing file if no override is provided during the presentment transaction. - `rampProviderId` string — The Ramp Provider ID is a unique identifier assigned by the Visa Network to third-party agents that facilitate the conversion of fiat currencies to non-fiat currencies (such as cryptocurrency) and vice versa. This field value is included in the scheme clearing file if no override is provided during the presentment transaction. - `acquirerBusinessId` string — The Acquirer Business ID is a unique identifier assigned to the acquiring entity associated with the merchant. This field value is included in the scheme clearing file if no override is provided during the presentment transaction. - `mcStagedDigitalWalletId` string — The Staged Digital Wallet ID is a unique identifier assigned by the MasterCard Network to digital wallet transactions that involve multiple stages to complete the transaction. It is used to track and manage these transactions, ensuring accurate processing once the wallet is activated. This field value is included in the scheme clearing file if no override is provided during the presentment transaction. - `salesDetails` MerchantUpdateDetailsSalesDetails — Please note that if this object was not provided during merchant onboarding, and the consumer wishes to update their sales information for the first time, the following fields must be populated: accSignedDate, accCreationDate, accApprovalDate, salesAgentId, businessOwnerId, salesChannel, and salesCurrencyCode. - `accSignedDate` string — Date merchant was signed up. Format YYYYMMDD - `accCreationDate` string — Date merchant was created in the system. Format YYYYMMDD - `accApprovalDate` string — Date merchant application was approved. Format YYYYMMDD - `salesAgentId` string — Code of sales agent associated with the sales process. Available options depends on the institution configuration. For a list of valid status codes use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal salesAgentId. - `businessOwnerId` string — Code of the business owner associated with the sales process. Available options depends on the institution configuration. For a list of valid status codes use Acquirer Profile API GET reference-data endpoint with query parameter clasifications equal businessOwnerId. - `salesChannel` string — Institution specific user defined list of potential sales channels. For a list of valid codes use Acquirer Profile API GET reference-data endpoint with query parameter classification equal salesChannelIndex when creating or editing an existing merchant profile. - `salesCurrencyCode` string — ISO 4217 Apha Currency code of amount fields displayed - `signedSalesValue` string — Contracted sales value for the merchant. Whether this value is per week, per month, per year, etc. is defined at institution level. Format NNN.NN - `signedAverageTicketValue` string — Contracted average ticket value for the merchant. Whether this value is per week, per month, per year, etc. is defined at institution level. - `salesLead` string — Name or description of the sales lead - `signedNumberSales` string — Contracted number of sales for the merchant. Whether this value is per week, per month, per year, etc. is defined at institution level - `priorityMemo` string — Free text for additonal note ## Response `200` OK - InlineResponse400 — An API response. The 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. The API response will contain at least one of the following top level members." - `meta` MetaType — Supplementary information about the data. - `paging` PagingMetaType — Map containing pagination related information about data. - `count` integer — Total number of records present in system which can be retrieved. - `totalPages` integer — Total number of pages with maximum limit taken into account. - `currentOffset` integer — Current offset used in request. - `currentNumberOfRetrievedRecords` integer — Current number of retrieved records. - `maxLimit` integer — Maximum limit of records that can be retrieved. - `hasMoreRecords` boolean — Indicates if there are more records available. - `pageNumber` integer — Current page number. - `sorting` SortingMetaType — Map containing sorting related information about data. - `sort` string — Indicates the elements the current data is sorted with and the direction of sorting. - `messages` ErrorType[] — Messages related to request processing or response data - any additional information or warnings to be returned in the case of a successful API call. - `id` string — Generated message identifier for particular request, helping to locate server logs. - `code` string, required — 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. - `title` string, required — Short description of the error. Not for displaying purposes. - `detail` string — Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType — Object containing references to the source of the message. - `pointer` string — Indicates the element in the request document which caused the error. - `parameter` string — Indicates which query parameter caused the error. - `header` string — Indicates which header caused the error. - `data` object[] — "Contains the primary data to be returned as the API response. Use this object only when respnse type is an array. It will not be returned in case of error." - `errors` ErrorType[] — "Contains one or more error messages and is mutually exclusive with the data item. This will not be returned in success scenarios." - `id` string — Generated message identifier for particular request, helping to locate server logs. - `code` string, required — 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. - `title` string, required — Short description of the error. Not for displaying purposes. - `detail` string — Provides additional low-level details about the error to assist with troubleshooting. Not for displaying purposes. - `source` SourceType — Object containing references to the source of the message. - `pointer` string — Indicates the element in the request document which caused the error. - `parameter` string — Indicates which query parameter caused the error. - `header` string — Indicates which header caused the error. - `links` LinksType — Contains the links to retrieve the resources exposed as part of this API. - `self` string — The link to the primary resource being retrieved in the request. - `first` string — This is to provide the link to retrieve the first record/page. This SHOULD be used in case server provides pagination of the resource. - `last` string — This is to provide the link to retrieve the last record/page. This SHOULD be used in case server provides pagination of the resource. - `prev` string — This is to provide the link to retrieve the previous record/page. This SHOULD be used in case server provides pagination of the resource. - `next` string — This is to provide the link to retrieve the last record. This SHOULD be used in case server provides pagination of the resource ## Other responses - `400` — Invalid request - `401` — Authorization error - `403` — Forbidden error i.e. Consumer token credentials are valid but lack of permissions to do this action. - `500` — Internal Server Error --- [API](https://skmtc.net/fiserv/apis/acquirer-profile-in-design.md) · [All operations](https://skmtc.net/fiserv/apis/acquirer-profile-in-design/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fiserv/acquirer-profile-in-design/revisions/dd7ef6ce81a1/schema)