Get Localization

GET 
/payment/localization/:merchantKey

Get currently valid localization data for a specific merchant. If used for the first time, it will return SmartPay default language configuration.

Request

Path Parameters

merchantKey string<uuid>required

Possible values: <= 36 characters

Merchant identifier.

Responses

200

Successful response

application/json

Schema

Schema

merchantKeystring<uuid>

Merchant identifier.

Possible values: <= 36 characters

merchantNamestring

The merchant's name.

Possible values: <= 255 characters

lastUpdateDateTimestring<date-time>

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

Possible values: <= 24 characters

requestDateTimestring<date-time>

The time when the user has downloaded the file.

Possible values: <= 24 characters

culturesEnabled object

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 (auto)

{
  "merchantKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "merchantName": "string",
  "lastUpdateDateTime": "2024-07-29T15:51:28.071Z",
  "requestDateTime": "2024-07-29T15:51:28.071Z",
  "culturesEnabled": {}
}

Example

{
  "culturesEnabled": {
    "de-DE": {
      "hpp:orderSummary": "Zusammenfassung der Bestellung",
      "hpp:success_long_text": "Ihre Zahlung wurde erfolgreich verarbeitet.",
      "stored-method:expired-warning": "Eine abgelaufene Zahlungsmethode ist nicht nutzbar.",
      "main-panel-registration:instruction": "Neue Zahlungsart speichern",
      "stored-method:add": "Neue Zahlungsart hinzufügen",
      "button:stored-payment": "Speichern",
      "main-panel-registration:instruction_detail": "Bitte wählen Sie eine Zahlungsart aus. Die Zahlungsinformationen geben Sie im letzten Schritt ein.",
      "stored-method:expires-soon": "Läuft bald ab",
      "sepa_mandate:creditor_identifier": "Gläubiger Id",
      "sepa_mandate:state": "Bundesland",
      "button:cancel": "Abbrechen",
      "3ri:instruction_detail": "Bitte wählen Sie eine Ihrer gespeicherten Zahlungsarten aus oder speichern Sie eine neue Zahlungsart.",
      "3ri:legal-text": "J.P. Mobility Payments Solutions S.A. verarbeitet als Datenverantwortlicher Ihre personenbezogenen Daten, unter anderem für die Abwicklung des Zahlungsvorgangs (weitere Einzelheiten entnehmen Sie in unserer Datenschutzerklärung)",
      "payment-method:PAYINVC": "Kauf auf Rechnung",
      "sepa_mandate:agree": "Zustimmen",
      "button:as-guest": "Als Gast zahlen",
      "hpp:itemName": "Artikelname",
      "hpp:quantity": "Menge",
      "hpp:success:your-transaction": "Ihre Transaktionsreferenz ist",
      "hpp:button:proceedToPayment": "Weiter zur Zahlung",
      "button:continue-guest": "Zahlung fortsetzen",
      "hpp:failure_long_text": "Bitte versuchen Sie es mit einer anderen Karte oder einer anderen Zahlungsmethode",
      "payment-method:PAYUBLK": "BLIK",
      "payment-method:VISA": "VISA",
      "hpp:success:please-quote": "Bitte geben Sie diese Nummer bei Ihrer Überweisung im Verwendungszweck an.",
      "payment-method:BNKACCT": "SEPA Direct Debit",
      "sepa_mandate:date": "Datum",
      "3ri:privacy-notice": "Datenschutzerklärung",
      "payment-method:PAYU": "PayU",
      "payment-method:PREPMNT": "Vorauskasse",
      "stored-method:default": "Bevorzugt",
      "stored-method:disabled": "Wartet auf Aktivierung / Inaktiv",
      "payment-method:CRTBANCAIR": "Carte Bancaire",
      "stored-method:back": "Zurück zu den vorhandenen Zahlungsarten",
      "button:try_again": "Versuchen Sie es erneut",
      "hpp:discountPercent": "Rabattprozentsatz",
      "sepa_mandate:account_holder": "Kontoinhaber",
      "sepa_mandate:mandate_info_second": "Hinweis: Ich kann/ Wir können innerhalb von acht Wochen, beginnend mit dem Belastungsdatum, die Erstattung des belasteten Betrages verlangen. Es gelten dabei die mit meinem/ unserem Kreditinstitut vereinbarten Bedingungen.",
      "popup-registration:instruction_detail": "Bitte geben Sie unten Ihre Zahlungsinformationen ein, um Ihre Zahlungsoption zu registrieren. Es erfolgt keine Zahlung.",
      "sepa_mandate:name": "Name",
      "payment-method:PAYPAL": "PayPal",
      "hpp:activePaymentError": "Mit dieser Anfrage ist bereits eine aktive Zahlung verbunden.",
      "hpp:discountAmount": "Rabattbetrag",
      "sepa_mandate:country": "Land",
      "stored-method:expiry_date": "Gültig bis:",
      "3ri:save-card": "Speicherung der Zahlungsinformationen für eine schneller Bezahlung beim nächsten Mal",
      "payment-method:CC": "Kreditkarte",
      "stored-method:active": "Aktiv",
      "hpp:failure_header": "Bezahlung fehlgeschlagen",
      "sepa_mandate:iban": "IBAN",
      "3ri:CC": "Neue Kredit-/Debitkarte hinzufügen",
      "3ri:instruction": "Gespeicherte Zahlungsarten",
      "sepa_mandate:mandate_reference": "Mandatsreferenz",
      "hpp:totalDue": "Gesamtbetrag fällig",
      "sepa_mandate:mandate_info_first": "Ich ermächtige/ Wir ermächtigen (A) $(fi-creditor-name), Zahlungen von meinem/ unserem Konto mittels Lastschrift einzuziehen. Zugleich (B) weise ich mein/ weisen wir unser Kreditinstitut an, die von $(fi-creditor-name) auf mein/ unser Konto gezogenen Lastschriften einzulösen.",
      "hpp:shippingAddress": "Versand",
      "button:submit": "Bestätigen",
      "hpp:billingAddress": "Rechnungsstellung",
      "main-panel-guest:instruction_detail": "Bitte wählen Sie eine Zahlungsart aus. Die Zahlungsinformationen geben Sie im letzten Schritt ein.",
      "hpp:success_header": "Danke!",
      "payment-method:AMEX": "AMEX",
      "payment-method:JCB": "JCB",
      "button:continue-registration": "Registrierung fortsetzen",
      "payment-method:MSTRCRD": "Mastercard",
      "payment-method:PAYUBNK": "Bank Transfer",
      "payment-method:IDEAL": "Ideal",
      "button:back-to-methods-selection": "Zurück",
      "stored-method:empty": "Keine gespeicherten Zahlungsarten vorhanden. Bitte fügen Sie eine neue Zahlungsart hinzu.",
      "sepa_mandate:address": "Adresse",
      "main-panel-guest:instruction": "Zahlungsart",
      "stored-method:remove": "Entfernen",
      "sepa_mandate:city": "Stadt",
      "sepa_mandate:post_code": "PLZ",
      "button:payment": "Bezahlen ${currencySign}${amount}",
      "main-panel-registered:instruction": "Gespeicherte Zahlungsarten",
      "main-panel-registered:instruction_detail": "Bitte wählen Sie eine Ihrer gespeicherten Zahlungsarten aus oder speichern Sie eine neue Zahlungsart.",
      "sepa_mandate:creditor": "Gläubiger",
      "stored-method:set_default": "Als Bevorzugt setzen",
      "hpp:grossAmount": "Bruttobetrag",
      "stored-method:expired": "Abgelaufen"
    },
    "en-EN": {
      "hpp:orderSummary": "Order summary",
      "hpp:success_long_text": "Your payment has been successfully processed.",
      "stored-method:expired-warning": "An expired payment method cannot be used.",
      "main-panel-registration:instruction": "Please select your new payment method",
      "stored-method:add": "Add new payment method",
      "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.",
      "stored-method:expires-soon": "Expires soon",
      "sepa_mandate:creditor_identifier": "Creditor identifier",
      "sepa_mandate:state": "State",
      "button:cancel": "Cancel",
      "3ri:instruction_detail": "Continue with one of your saved payment methods or add a new one.",
      "3ri:legal-text": "J.P. Mobility Payments Solutions S.A., as a data controller, processes your personal data for the completion of the payment transaction among other purposes (more details in our privacy notice)",
      "payment-method:PAYINVC": "Pay Upon Invoice",
      "sepa_mandate:agree": "Agree",
      "button:as-guest": "Pay as a guest",
      "hpp:itemName": "Item Name",
      "hpp:quantity": "Qty",
      "hpp:success:your-transaction": "Your transaction reference is",
      "hpp:button:proceedToPayment": "Proceed to payment",
      "button:continue-guest": "Continue Payment",
      "hpp:failure_long_text": "Please try another card or a different payment method",
      "payment-method:PAYUBLK": "BLIK",
      "payment-method:VISA": "VISA",
      "hpp:success:please-quote": "Please quote this number in the purpose of payment when submitting your bank transfer.",
      "payment-method:BNKACCT": "SEPA Direct Debit",
      "sepa_mandate:date": "Date",
      "3ri:privacy-notice": "privacy notice",
      "payment-method:PAYU": "PayU",
      "payment-method:PREPMNT": "Prepayment",
      "stored-method:default": "default",
      "stored-method:disabled": "Pending Activation / Inactive",
      "payment-method:CRTBANCAIR": "Carte Bancaire",
      "stored-method:back": "Back to stored payments",
      "button:try_again": "Try again",
      "hpp:discountPercent": "Discount Percent",
      "sepa_mandate:account_holder": "Account Owner",
      "sepa_mandate:mandate_info_second": "As part of your rights, you are entitled to a chargeback from your bank under the terms and conditions of your agreement with your bank. A chargeback must be claimed within 8 weeks starting from the date on which your account was debited.",
      "popup-registration:instruction_detail": "Please enter your payment method details below in order to register your payment option. No payment will be performed.",
      "sepa_mandate:name": "Name",
      "payment-method:PAYPAL": "PayPal",
      "hpp:activePaymentError": "There is already an active payment associated with this request.",
      "hpp:discountAmount": "Discount Amount",
      "sepa_mandate:country": "Country",
      "stored-method:expiry_date": "Expires",
      "3ri:save-card": "Save payment info to pay faster next time",
      "payment-method:CC": "Credit Card / Debit Card",
      "stored-method:active": "Active",
      "hpp:failure_header": "Payment failed",
      "sepa_mandate:iban": "IBAN",
      "3ri:CC": "Add new credit / debit card",
      "3ri:instruction": "Choose a payment method",
      "sepa_mandate:mandate_reference": "Mandate reference",
      "hpp:totalDue": "Total due",
      "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)",
      "hpp:shippingAddress": "Shipping",
      "button:submit": "Continue",
      "hpp:billingAddress": "Billing",
      "main-panel-guest:instruction_detail": "We will ask you to enter your details in the next step.",
      "hpp:success_header": "Thank you!",
      "payment-method:AMEX": "AMEX",
      "payment-method:JCB": "JCB",
      "button:continue-registration": "Continue Registration",
      "payment-method:MSTRCRD": "Mastercard",
      "payment-method:PAYUBNK": "Bank Transfer",
      "payment-method:IDEAL": "Ideal",
      "button:back-to-methods-selection": "Back",
      "stored-method:empty": "No stored payments available. Please add a new payment method.",
      "sepa_mandate:address": "Address",
      "main-panel-guest:instruction": "Please select your payment method",
      "stored-method:remove": "delete",
      "sepa_mandate:city": "City",
      "sepa_mandate:post_code": "PostCode",
      "button:payment": "Pay ${currencySign}${amount}",
      "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.",
      "sepa_mandate:creditor": "Creditor",
      "stored-method:set_default": "set as default",
      "hpp:grossAmount": "Gross Amount",
      "stored-method:expired": "Expired"
    }
  },
  "merchantName": "CW Generic Merchant",
  "lastUpdateDateTime": "2021-07-06T11:28:33.491Z",
  "requestTime": "2021-07-09T10:05:20.261Z",
  "merchantKey": "23016498-3dd9-4be3-a76f-6454894564"
}

400

Bad request - invalid culturesEnabled parameter.

application/json

No schema

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."
    }
  ]
}