Merchant Onboarding

Notify Merchant Update

post

Notify the token requestor about a merchant onboarding update.

In case of retryable error returned by the token requestor, the notification will be resent periodically with exponential backoff.

Authorizations

BasicAuth

AuthorizationstringRequired

Header parameters

authorizationanyRequired

Technical identifier pre-defined at on-boarding that identifies the API consumer. Format shall be the string 'APIKEY' followed by a space and the api key value. Example: APIKEY c03f88fe-01ba-11e8-ba89-0ed5f89f718b

x-correlation-idanyRequired

A unique message identifier. It eventually correlates the notification with a request if any. The goal is to help on customer support when needed.

Body

application/json

merchantIdstring · min: 1 · max: 128Required

Identifier of the merchant provided by Thales at on-boarding.

schemestring · enum · max: 32Required

The card primary scheme.

Example: VISAPossible values:

trIdstring · min: 1 · max: 32Optional

The Token Requestor Identifier generated by the scheme for that merchant. In case of Mastercard Secure Card-On-File program, this field is not returned, see 'mcServiceId' instead.

Example: 40000000080

mcServiceIdstring · min: 1 · max: 256Optional

Token Requestor Id for SCOF solution, equivalent to the TRID. It is assigned by Mastercard to entity for which tokens are created.

lastUpdateTimestampstring · max: 64Optional

Last update timestamp compliant with ISO 8601.

Example: 2017-11-13T11:012:41.165Z

Responses

204

No Content

No content

400

Bad request - Not Retryable

401

Unauthorized - Not Retryable

404

Not Found - Not Retryable

429

Too Many Requests - Retryable

500

Internal Server Error - Retryable

503

Service Unavailable - Retryable

post/notify-merchant-update

HTTPcURLJavaScriptPython

POST /tsh-cof/notify-merchant-update HTTP/1.1
Authorization: Basic username:password
authorization: null
x-correlation-id: null
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "merchantId": "text",
  "scheme": "VISA",
  "trId": "40000000080",
  "mcServiceId": "text",
  "error": {
    "errorCode": "TSP_NON_RETRYABLE_ERROR",
    "errorDetails": "text"
  },
  "lastUpdateTimestamp": "2017-11-13T11:012:41.165Z"
}

No content