Update Merchant

Operation to create or update a merchant and define the merchant's general details.

POST https://anzworldline.gateway.mastercard.com/api/nvp/version/62

Authentication

This operation requires authentication via one of the following methods:


  • Certificate authentication.
  • To authenticate to the API two additional NVP parameters must be supplied in the request. Provide 'MSO.<your gateway MSO ID>' in the apiUsername field and your API password in the apiPassword field.

Request

Fields

apiOperation String = UPDATE_MERCHANT FIXED

Any sequence of zero or more unicode characters.

correlationId String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
merchant REQUIRED

The merchant's general details.

merchant.address REQUIRED

The address of the merchant.

merchant.address.city String REQUIRED

The city or town of the merchant's billing address.

Data can consist of any characters

Min length: 1 Max length: 30
merchant.address.countryCode Upper case alphabetic text REQUIRED

The country of the merchant's billing address.

The value must be a three-letter country code according to ISO 3166-1 alpha-3.

Data must consist of the characters A-Z

Min length: 3 Max length: 3
merchant.address.postcode String REQUIRED

The zip or postal code of the merchant's billing address.

Data can consist of any characters

Min length: 1 Max length: 16
merchant.address.stateProvince String REQUIRED

The state or province code of the merchant's billing address.

For merchants in the United States provide the 2-letter ISO 3166-2 state code. For US military bases provide one of AE, AA, AP.

For Canadian merchants provide the 2-letter ISO 3166-2 province code.

Data can consist of any characters

Min length: 1 Max length: 30
merchant.address.street1 String REQUIRED

The street address of the merchant's billing address.

Data can consist of any characters

Min length: 1 Max length: 40
merchant.address.street2 String OPTIONAL

The street address of the merchant's merchant's billing address.

Data can consist of any characters

Min length: 1 Max length: 40
merchant.categoryCode Digits REQUIRED

A 4 digit industry specific code that describes the business or industry the merchant operates in.

Data is a string that consists of the characters 0-9.

Min length: 4 Max length: 4
merchant.contactName String OPTIONAL

The name of the person to contact within the merchant's business.

Data can consist of any characters

Min length: 1 Max length: 100
merchant.email Email OPTIONAL

The email address of the person to contact within the merchant's business.

Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses

merchant.escalationPhone String OPTIONAL

The phone number to call in case the regular phone number is not available.

Data can consist of any characters

Min length: 1 Max length: 20
merchant.faxNumber String OPTIONAL

The fax number of the merchant's business.

Data can consist of any characters

Min length: 1 Max length: 20
merchant.goodsDescription String REQUIRED

Description of the merchant's goods, for example, books or electronics.

Data can consist of any characters

Min length: 1 Max length: 80
merchant.locale String REQUIRED

The default language displayed in Merchant Administrator unless overridden by the Operator.

The value must be provided in the format '<Language>_<Country>', e.g. 'en_US'. <Language> must be a two-letter language code according to ISO 639-1. <Country> must be a two-letter country code according to ISO 3166-1 alpha-2.

Data can consist of any characters

Min length: 2 Max length: 5
merchant.merchantOrganization[n] Alphanumeric + additional characters OPTIONAL

The merchant organizations that this merchant belongs to.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 16
merchant.mobilePhone String OPTIONAL

The mobile phone number to call in case the regular phone number is not available.

Data can consist of any characters

Min length: 1 Max length: 16
merchant.name String REQUIRED

The merchant's registered business, trading or organization name.

Data can consist of any characters

Min length: 1 Max length: 100
merchant.partnerId String OPTIONAL

A unique ID of the reseller partner or a referral partner the merchant has signed up with, to use the services offered by the MSO.

Providing this ID will help in tracking and analyzing the relationship between partners and their merchants, which may be useful for billing and reporting purposes.

Data can consist of any characters

Min length: 1 Max length: 40
merchant.phone String OPTIONAL

The phone number of the merchant's business.

Data can consist of any characters

Min length: 1 Max length: 20
merchant.state Enumeration OPTIONAL

Use this field to indicate whether or not the merchant may use gateway features configured on their merchant profile.

By default this field is set to ENABLED.

Value must be a member of the following list. The values are case sensitive.

DISABLED

The merchant cannot use any of the gateway features configured on their merchant profile and cannot log into merchant UIs.

ENABLED

The merchant may use all of the gateway features configured on their merchant profile and may also log into merchant UIs.

merchant.timeZone String REQUIRED

Defines the default time zone used for merchant operators in Merchant Administration, unless overridden by the operator.

It is used to display the transaction time. The value must be provided in the form '<Continent>/<City>', e.g. 'America/New_York'. For a complete list of timezones please refer to http://twiki.org/cgi-bin/xtra/tzdatepick.html.

Data can consist of any characters

Min length: 1 Max length: 40
merchant.tradingId String OPTIONAL

A unique identifier allocated to the merchant by ANZ Worldline Payment Solutions if different from the Merchant ID.

Data can consist of any characters

Min length: 1 Max length: 16
merchant.tradingName String OPTIONAL

The trading name of the merchant's business if it is different to that of the company name.

Data can consist of any characters

Min length: 1 Max length: 100
merchant.webSite Url OPTIONAL

URL of the merchant's website.

This is mandatory if the merchant is enrolled in a 3DSecure scheme.

Ensure that the URL begins with 'https' and is longer than 11 characters.

merchant.administrativePassword String OPTIONAL

The administrative password for the merchant.

Data can consist of any characters

Min length: 8 Max length: 4098
merchant.id Alphanumeric + additional characters REQUIRED

The unique identifier issued to you by your payment provider.

This identifier can be up to 12 characters in length.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_'

Min length: 1 Max length: 36
mso Alphanumeric + additional characters REQUIRED

The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'

Min length: 1 Max length: 16

Response

Fields

correlationId String CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100
result Enumeration ALWAYS PROVIDED

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

FAILURE

The operation was declined or rejected by the gateway, acquirer or issuer

PENDING

The operation is currently in progress or pending processing

SUCCESS

The operation was successfully processed

UNKNOWN

The result of the operation is unknown

Errors

error

Information on possible error conditions that may occur while processing an operation using the API.

error.cause Enumeration

Broadly categorizes the cause of the error.

For example, errors may occur due to invalid requests or internal system failures.

Value must be a member of the following list. The values are case sensitive.

INVALID_REQUEST

The request was rejected because it did not conform to the API protocol.

REQUEST_REJECTED

The request was rejected due to security reasons such as firewall rules, expired certificate, etc.

SERVER_BUSY

The server did not have enough resources to process the request at the moment.

SERVER_FAILED

There was an internal system failure.

error.explanation String

Textual description of the error based on the cause.

This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.

Data can consist of any characters

Min length: 1 Max length: 1000
error.field String

Indicates the name of the field that failed validation.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Data can consist of any characters

Min length: 1 Max length: 100
error.supportCode String

Indicates the code that helps the support team to quickly identify the exact cause of the error.

This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.

Data can consist of any characters

Min length: 1 Max length: 100
error.validationType Enumeration

Indicates the type of field validation error.

This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.

Value must be a member of the following list. The values are case sensitive.

INVALID

The request contained a field with a value that did not pass validation.

MISSING

The request was missing a mandatory field.

UNSUPPORTED

The request contained a field that is unsupported.

result Enumeration

A system-generated high level overall result of the operation.

Value must be a member of the following list. The values are case sensitive.

ERROR

The operation resulted in an error and hence cannot be processed.