Sign in

v1

latestOpenAPI 3.0.02026-07-2480677847.6 KB
Merchant Details

Update merchant details information

Update the Merchant Details information with immediate effect for the provided merchant number

put/merchant-details

Headers

Content-Type'application/json' | 'application/json;charset=UTF-8' required

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.

FSV-Interaction-Idstring required
Example:9591e6d8-0d70-11ea-8d71-362b9e155667

An RFC4122 UUID used as to trace requests.

Environmentstring required

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.

Institution-Numberstring required
Example:00000099

Institution number (8-digit number) associated with the merchant. This information defines the acquirer for the merchant.

Internal-Merchant-Idstring required

OPY Internal Client Number

Request body

Example request

{
  "requiredDetails": {
    "externalMerchantId": "0000075999959",
    "tradeName": "Insomnia",
    "companyName": "Omnipay Ltd.",
    "legalForm": "001",
    "languageIndex": "001",
    "mcciso": "8021",
    "eCommerceIndCode": "BOTH",
    "residentStatusCode": "NA",
    "accountOfficerIndex": "000",
    "retailerClassificationCode": "798",
    "branchIndex": "000"
  },
  "optionalDetails": {
    "registrationNo": "000000000000000",
    "vatRegNo": "MT 10644256",
    "secondaryTaxId": "MT 10644256",
    "contractReference": "00000000",
    "bankReference": "00000000",
    "merchantGradeIndex": "001",
    "prosaDeterminant": "Determin",
    "prosaBDUNumber": "12345678",
    "signerDateOfBirth": "20201030",
    "merchantLongName": "Omnipay Ltd.",
    "mcpRateType": "E",
    "domesticMcc": "8021"
  },
  "contracts": {
    "paymentMethodIndex": "000",
    "protectAgainstFXChange": true,
    "clientRegionIndex": "901",
    "reclassBillbackIndicatorCode": "NA",
    "withholdIncomeTariffIndex": "001007",
    "withholdVatTariffIndex": "001007",
    "regionalTaxIndex": "000"
  },
  "location": {
    "country": "IRE",
    "state": "MYS",
    "cityUrl": "Paris",
    "telephone": "0353-1234567891",
    "zip": "D18 R529",
    "street": "Rue Raynouard 24",
    "serviceTelNo": "+123 023 2345678",
    "countyIndex": "840",
    "fax": "+123 45 7809111",
    "salutation": "THE_DIRECTOR",
    "regionOverrideFlag": true,
    "url": "www.abc.com"
  },
  "schemeDetails": {
    "crossBorderFeeCode": "NONE",
    "masterCardIPQualificationCode": "NA",
    "masterCardIPValue": "00000055",
    "visaIPQualificationCode": "NA",
    "visaIPValue": "401938547",
    "cbdipVisaSmiCode": "aTT345200",
    "mcPaymentFacilitatorId": "12345",
    "visaPaymentFacilitatorId": "AbC12345",
    "mcIndependentSalesOrgId": "1234",
    "viLacFeeCode": "NA",
    "mcLacFeeCode": "MC_LAC_BOTH",
    "visaEuFeeIndCode": "BOTH_VISA_EU_FEES",
    "viUsApIafFee": "003",
    "pagobancomatIndex": "000",
    "mcCnpMotoFee": "NO_FEE",
    "dinersIntesCode": "123",
    "amexModelIndex": "001",
    "merchantCountryOfOrigin": "IRE",
    "merchantSizeIndex": "003",
    "mvi": "NOT_ELIGIBLE",
    "globalFees": [
      {
        "feeIndex": "060",
        "feeMode": true,
        "cardOrganization": "002"
      }
    ],
    "upiIPQualificationCode": "AMPET1",
    "marketPlaceId": "23412345",
    "stagedDigitalWalletId": "23456454",
    "rampProviderId": "45321456",
    "acquirerBusinessId": "61234456",
    "mcStagedDigitalWalletId": "12345678910"
  },
  "salesDetails": {
    "accSignedDate": "20200615",
    "accCreationDate": "20200615",
    "accApprovalDate": "20200615",
    "salesAgentId": "99999999",
    "businessOwnerId": "99999999",
    "salesChannel": "000",
    "salesCurrencyCode": "EUR",
    "signedSalesValue": "10.0",
    "signedAverageTicketValue": "10.0",
    "salesLead": "Free text",
    "signedNumberSales": "50",
    "priorityMemo": "Free text for any addition notes or other information"
  }
}

Response

OK

dataobject[]

"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."

Example response

{
  "meta": {
    "paging": {
      "count": 100,
      "totalPages": 10,
      "currentOffset": 1,
      "currentNumberOfRetrievedRecords": 10,
      "maxLimit": 10,
      "hasMoreRecords": true,
      "pageNumber": 1
    },
    "sorting": {
      "sort": "name,-startDate"
    },
    "messages": [
      {
        "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
        "code": "ACCOUNT_NUMBER_NOT_FOUND",
        "title": "The authorization credentials required for this request are invalid.",
        "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
        "source": {
          "pointer": "/dogs/name",
          "parameter": "type",
          "header": "type"
        }
      }
    ]
  },
  "errors": [
    {
      "id": "dd4ba13c-4a3c-4078-a31f-35ac9c07a8f7",
      "code": "ACCOUNT_NUMBER_NOT_FOUND",
      "title": "The authorization credentials required for this request are invalid.",
      "detail": "SQLException found while trying to establish the connection with table TUKCDHN.",
      "source": {
        "pointer": "/dogs/name",
        "parameter": "type",
        "header": "type"
      }
    }
  ],
  "links": {
    "self": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=3&limit=10",
    "first": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=1&limit=10",
    "last": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=10&limit=10",
    "prev": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=2&limit=10",
    "next": "https://api.firstdata.com/ipp/accounts-management/v1/accounts?offset=4&limit=10"
  }
}