PATCH /entities/{entityUid}/tradingAddress

A partial update of an existing Merchant Entity Address. Only replaces the provided parameters.

Servers

Path parameters

Name Type Required Description
entityUid String Yes

The Verifone assigned ID corresponding to the entity.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
addressLine3 String No

Address Line 3

receiverName String No

The receiver name for the address if different to the company/site name.

countrySubdivision String No

Identifies a sub-division of a country which may be state, region or county. This follows a similar format to the openbank api.

postCode String No

Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail.

poBox String No

The PO BOX number.

country String No

The ISO 3166-1 alpha-3 country code.

Note: The country code for Great Britain is GB and not UK as is used in that country's top-level domain names.
.

Valid values:

  • "KAZ"
  • "LBY"
  • "BEL"
  • "GUM"
  • "BHR"
  • "BLZ"
  • "PAK"
  • "JAM"
  • "NFK"
  • "CYP"
  • "COL"
  • "SYR"
  • "MYT"
  • "HKG"
  • "BDI"
  • "FSM"
  • "CHN"
  • "HTI"
  • "TCD"
  • "RWA"
  • "DEU"
  • "LVA"
  • "TZA"
  • "ARG"
  • "GEO"
  • "HRV"
  • "GNQ"
  • "COK"
  • "CUW"
  • "SYC"
  • "GTM"
  • "USA"
  • "SGP"
  • "UKR"
  • "NRU"
  • "MAF"
  • "ABW"
  • "MNP"
  • "SAU"
  • "NIC"
  • "PNG"
  • "SVN"
  • "CHL"
  • "PAN"
  • "AZE"
  • "VUT"
  • "GNB"
  • "CAN"
  • "BRB"
  • "ARE"
  • "CYM"
  • "PHL"
  • "WSM"
  • "ERI"
  • "TON"
  • "BOL"
  • "JPN"
  • "TWN"
  • "HUN"
  • "KGZ"
  • "AGO"
  • "JEY"
  • "NIU"
  • "ROU"
  • "BRA"
  • "SEN"
  • "TGO"
  • "THA"
  • "DMA"
  • "GLP"
  • "LSO"
  • "NGA"
  • "UZB"
  • "FRO"
  • "GRL"
  • "GMB"
  • "YEM"
  • "ATG"
  • "BSB"
  • "LBN"
  • "NOR"
  • "SGC"
  • "POL"
  • "UMI"
  • "AIA"
  • "KHM"
  • "COG"
  • "FIN"
  • "SDN"
  • "CUB"
  • "ATF"
  • "PLW"
  • "MMR"
  • "RUS"
  • "ESH"
  • "LCA"
  • "VCT"
  • "IMN"
  • "DJI"
  • "LKA"
  • "CMR"
  • "BMU"
  • "PSE"
  • "MCO"
  • "GGY"
  • "NCL"
  • "FRA"
  • "TUN"
  • "PRT"
  • "BRN"
  • "MDA"
  • "MTQ"
  • "MUS"
  • "BLR"
  • "MNE"
  • "SWE"
  • "HND"
  • "REU"
  • "LAO"
  • "SMR"
  • "IDN"
  • "OMN"
  • "COD"
  • "KIR"
  • "SUR"
  • "STP"
  • "ETH"
  • "LTU"
  • "IOT"
  • "GIN"
  • "VIR"
  • "ISL"
  • "CPV"
  • "TKL"
  • "BES"
  • "LBR"
  • "NER"
  • "SJM"
  • "GUF"
  • "ZAF"
  • "UGA"
  • "CRI"
  • "JOR"
  • "LUX"
  • "BVT"
  • "CHE"
  • "MNG"
  • "AFG"
  • "HMD"
  • "MWI"
  • "CCK"
  • "NZL"
  • "TKM"
  • "VNM"
  • "TJK"
  • "MLT"
  • "GBR"
  • "MOZ"
  • "ALB"
  • "MHL"
  • "ECU"
  • "TTO"
  • "WLF"
  • "AUT"
  • "MSR"
  • "VAT"
  • "SLB"
  • "IRL"
  • "EST"
  • "CAF"
  • "ZZZ"
  • "IND"
  • "CIV"
  • "ATA"
  • "URY"
  • "ALA"
  • "ARM"
  • "TUR"
  • "BTN"
  • "AUS"
  • "GUY"
  • "BGD"
  • "BIH"
  • "PYF"
  • "QAT"
  • "MDV"
  • "MEX"
  • "SWZ"
  • "NAM"
  • "PRY"
  • "GRC"
  • "ITA"
  • "AND"
  • "KEN"
  • "KOR"
  • "ZWE"
  • "BFA"
  • "CXR"
  • "PRI"
  • "DNK"
  • "GAB"
  • "DOM"
  • "MKD"
  • "IRN"
  • "BLM"
  • "FLK"
  • "VEN"
  • "GIB"
  • "CZE"
  • "GRD"
  • "SPM"
  • "ASM"
  • "VGB"
  • "MDG"
  • "NPL"
  • "SXM"
  • "ZMB"
  • "NLD"
  • "SLE"
  • "SLV"
  • "GHA"
  • "KNA"
  • "MAR"
  • "BWA"
  • "DZA"
  • "BEN"
  • "BGR"
  • "SHN"
  • "TLS"
  • "EGY"
  • "TCA"
  • "MRT"
  • "ESP"
  • "ISR"
  • "KWT"
  • "LIE"
  • "FJI"
  • "PRK"
  • "PER"
  • "SSD"
  • "SRB"
  • "BHS"
  • "TUV"
  • "PCN"
  • "SOM"
  • "MAC"
  • "MLI"
  • "SVK"
  • "COM"
  • "IRQ"
  • "MYS"
addressLine1 String No

Address Line 1. Should include street and apartment number if required.

city String No

Name of a built-up area, with defined boundaries, and a local government. This could be city or town.

timeZone String No

A time zone, following the format defined in the IANA tz database (https://www.iana.org/time-zones). Valid examples are America/New_York and Etc/UTC. Do not use ambiguous, non-qualified values such as EST or GB. Before including this type in your interface, please consider whether it is actually appropriate to convey time zone information with your type. It is almost always the case that this should be transformed from UTC at the time of display to the user; this type might therefore be most associated with user-preference APIs.

addressLine2 String No

Address Line 2

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.