Update Localization

POST 
/payment/localization/:merchantKey

Upload custom localization data for some or all supported languages.

Request

Path Parameters

merchantKey string<uuid>required

Possible values: <= 36 characters

Merchant identifier.

application/json

Body

Bodyrequired

merchantKeystring<uuid>required

Merchant identifier.

Possible values: <= 36 characters

merchantNamestringrequired

The merchant's name.

Possible values: <= 255 characters

lastUpdateDateTimestring<date-time>required

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

Possible values: <= 24 characters

requestTimestring<date-time>required

The time when the user has downloaded the file.

Possible values: <= 24 characters

culturesEnabled objectrequired

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.

Example

{
  "culturesEnabled": {
    "en-EN": {
      "sepa_mandate:name": "This value is changed",
      "payment-method:PAYPAL": "PayPal",
      "main-panel-registration:instruction": "Please select your new payment method",
      "sepa_mandate:country": "Country",
      "stored-method:add": "Add new payment",
      "stored-method:expiry_date": "Expires",
      "button:stored-payment": "Confirm",
      "main-panel-registration:instruction_detail": "We will ask you to enter your details in the next step to register your payment option.",
      "payment-method:CC": "Credit Card / Debit Card",
      "sepa_mandate:iban": "IBAN",
      "sepa_mandate:creditor_identifier": "Creditor identifier",
      "sepa_mandate:state": "State",
      "sepa_mandate:mandate_reference": "Mandate reference",
      "button:cancel": "Cancel",
      "sepa_mandate:mandate_info_first": "By signing this mandate form, you authorise (A) $(fi-creditor-name) to send instructions to your bank to debit your account and (B) your bank to debit your account in accordance with the instructions from $(fi-creditor-name)",
      "button:submit": "Continue",
      "payment-method:PAYINVC": "Pay Upon Invoice",
      "sepa_mandate:agree": "Agree",
      "button:as-guest": "Pay as a guest",
      "main-panel-guest:instruction_detail": "We will ask you to enter your details in the next step.",
      "payment-method:AMEX": "AMEX",
      "payment-method:JCB": "JCB",
      "payment-method:MSTRCRD": "Mastercard",
      "payment-method:IDEAL": "Ideal",
      "stored-method:empty": "No stored payments available. Please add a new payment method.",
      "payment-method:VISA": "VISA",
      "sepa_mandate:address": "Address",
      "main-panel-guest:instruction": "Please select your payment method",
      "payment-method:BNKACCT": "SEPA Direct Debit",
      "sepa_mandate:date": "Date",
      "stored-method:remove": "delete",
      "sepa_mandate:city": "City",
      "payment-method:PAYU": "PayU",
      "sepa_mandate:post_code": "PostCode",
      "payment-method:PREPMNT": "Prepayment",
      "stored-method:default": "default",
      "button:payment": "Pay Now",
      "main-panel-registered:instruction": "Choose a payment method",
      "main-panel-registered:instruction_detail": "Continue with one of your saved payment methods or add a new one.",
      "payment-method:CRTBANCAIR": "Carte Bancaire",
      "stored-method:back": "Back to stored payments",
      "sepa_mandate:creditor": "Creditor",
      "sepa_mandate:account_holder": "Account Owner",
      "stored-method:set_default": "set as default",
      "sepa_mandate:mandate_info_second": "As part of your rights, you are entitled to a refund from your bank under the terms and conditions of your agreement with your bank. A refund must be claimed within 8 weeks starting from the date on which your account was debited."
    }
  },
  "merchantName": "CW Generic Merchant",
  "lastUpdateDateTime": "2021-07-06T11:28:33.491Z",
  "requestTime": "2021-07-09T10:05:20.261Z",
  "merchantKey": "23016498-3dd9-4be3-a76f-6454894564"
}

Responses

200

Successful response

application/json

Schema

Schema

merchantKeystring<uuid>

Merchant identifier.

Possible values: <= 36 characters

messagestring

Information regarding processing status.

Example (auto)

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

messagestring

Error message.

culturesEnabled object
Missing keys in the cultures configuration.
property name* object
property name*string

Example (auto)

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

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

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

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

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

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

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

errorstring
errorDetails object
contextobject
gatewayDescriptionstring
paymentProviderDescriptionstring
message object
oneOf
• string
• string[]
string

Example (auto)

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

Example

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