Update Localization

POST 
/payment/localization/:merchantKey

Upload custom localization data for some or all supported languages.

Request

Path Parameters

merchantKey uuidrequired

Possible values: <= 36 characters

Merchant identifier.

application/json

Body

required

merchantKey uuidrequired

Possible values: <= 36 characters

Merchant identifier.

merchantName stringrequired

Possible values: <= 255 characters

The merchant's name.

lastUpdateDateTime date-timerequired

Possible values: <= 24 characters

The time when the merchant's strings were updated last time.

requestTime date-timerequired

Possible values: <= 24 characters

The time when the user has downloaded the file.

culturesEnabled

object

required

An object which consists of all culture codes enabled by the merchant.

property name*

object

cultureEntry. Name:Value pairs. See String ID reference.

property name* string

Name:Value pairs. See String ID reference.

Responses

200

Successful response

application/json

Schema

Schema

merchantKey uuid

Possible values: <= 36 characters

Merchant identifier.

message string

Information regarding processing status.

Example (from schema)

{
  "merchantKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "string"
}

Example

{
  "merchantKey": "23016498-3dd9-4be3-a76f-6454894564",
  "message": "The culture configuration has been successfully updated"
}

400

Bad Request

info

For error handling, please refer to this section.

application/json

Schema

Schema

message string

Error message.

culturesEnabled

object

Missing keys in the cultures configuration.

property name*

object

property name* string

Example (from schema)

{
  "message": "string",
  "culturesEnabled": {}
}

Example

{
  "message": "Some keys are missing. Refer to the list below.",
  "culturesEnabled": {
    "en-US": {
      "button_cancel": "CANCEL",
      "button_confirm": "CONFIRM"
    },
    "en-de": {
      "button_cancel": "CANCEL"
    }
  }
}

401

Unauthenticated

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You are not authenticated to perform this request.",
      "code": "unauthorized"
    }
  ]
}

403

Forbidden

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "You do not have permissions to perform this request.",
      "code": "forbidden"
    }
  ]
}

404

Not Found

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Resource not found.",
      "code": "not_found"
    }
  ]
}

500

Internal Server Error

info

For error handling, please refer to this section.

application/json

Schema

Schema

error string

errorDetails

object

context object

gatewayDescription string

paymentProviderDescription string

message

object

oneOf

MOD1

string

MOD2

Array [

string

]

Example (from schema)

{
  "error": "string",
  "errorDetails": {
    "context": {},
    "gatewayDescription": "string",
    "paymentProviderDescription": "string"
  },
  "message": "string"
}

Example

{
  "traceId": "00-1234567890abcdef0123456789abcdef-0123456789abcdef-00",
  "errors": [
    {
      "message": "Internal server error."
    }
  ]
}

Loading...