Payment translations

Translate payment method names at checkout and online payment discount offer texts, per market, through the Store API.

Get a payment provider name translation

GET read_markets + read_translations

Read the translation of a provider's checkout name.

Returns the stored translation of checkout_name in the selected locale, with is_outdated (the name changed since it was translated). Shoppers in that language see it at checkout and in their order emails; without one they see the checkout name. Only a provider with a checkout name in this market has a translation: otherwise TRANSLATION_RESOURCE_ID_NOT_IN_STORE. Fields without a translation in this locale are omitted from the response. An omitted field is not empty: shoppers see the store's base-language value, which the resource's own GET endpoint returns.

Path parameters

Name Type Description
marketId required uuid

Market id.

Example: 9a1f2c3d-4e5f-6789-abcd-ef0123456789
bindingId required uuid

Connected payment binding id.

Example: 5b2e8d90-1234-4678-9abc-def012345678
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 STORE_API_INVALID_REQUEST_BODY

    marketId must be a valid UUID.

  • 404 SERVICE_BINDING_NOT_FOUND

    No connected provider with this binding id is available to this market.

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The provider has no checkout name in this market to translate.

Set a payment provider name translation

PUT write_markets + write_translations

Translate a provider's checkout name.

The only translatable field is checkout_name, up to checkout_name_max_length characters. Send an empty string to remove the translation. The provider must have a checkout name in this market. A write waits at most 2 seconds for other translation writes of the same item or of a clashing name or slug (for example a translation CSV import writing the same language); writes of other items, types and languages never wait. A row or call that fails with TRANSLATION_WRITE_BUSY (HTTP 503) saved nothing: send it again after error.details.retry_after_seconds (the call's Retry-After header says the same). Every row or call either saved or reports an error; none is left in an unknown state.

Path parameters

Name Type Description
marketId required uuid

Market id.

Example: 9a1f2c3d-4e5f-6789-abcd-ef0123456789
bindingId required uuid

Connected payment binding id.

Example: 5b2e8d90-1234-4678-9abc-def012345678
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Idempotency-Key string

Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name Type Description
translations required object

Field-keyed translation values: checkout_name.

Example: {"checkout_name": "UPI, Karten und Netbanking"}

Errors

  • 400 STORE_API_INVALID_REQUEST_BODY

    marketId must be a valid UUID.

  • 404 SERVICE_BINDING_NOT_FOUND

    No connected provider with this binding id is available to this market.

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The provider has no checkout name in this market to translate.

  • 400 STORE_API_INVALID_REQUEST_BODY

    Request body must be a JSON object containing only documented fields.

  • 400 TRANSLATION_FIELD_NOT_TRANSLATABLE

    Only checkout_name is translatable for payment providers.

  • 400 TRANSLATION_FIELD_VALUE_TOO_LONG

    The translated name is longer than checkout_name_max_length characters.

  • 400 TRANSLATION_STAGING_INVALID_CONTROL_CHARS

    The translated name contains unsupported control characters.

  • 503 TRANSLATION_WRITE_BUSY

    Other translation writes held the item or a clashing name or slug for more than 2 seconds; nothing was saved. Send the request again after error.details.retry_after_seconds (also the Retry-After header).

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.

Get a payment adjustment translation

GET read_markets + read_translations

Read the offer text translations of an online payment discount.

Returns the stored translations of offer_label, offer_conditions and offer_note in the selected locale, each with is_outdated (the text changed since it was translated). Shoppers in that language see them on product pages; without one they see the original text. Only a discount with at least one offer text has translations: otherwise TRANSLATION_RESOURCE_ID_NOT_IN_STORE. Fields without a translation in this locale are omitted from the response. An omitted field is not empty: shoppers see the store's base-language value, which the resource's own GET endpoint returns.

Path parameters

Name Type Description
marketId required uuid

Market id.

Example: 9a1f2c3d-4e5f-6789-abcd-ef0123456789
bindingId required uuid

Connected payment binding id.

Example: 5b2e8d90-1234-4678-9abc-def012345678
ruleId required uuid

Payment adjustment id.

Example: 6b2e8d90-1234-4678-9abc-def012345678
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Errors

  • 400 STORE_API_INVALID_REQUEST_BODY

    marketId must be a valid UUID.

  • 404 PAYMENT_ADJUSTMENT_NOT_FOUND

    No adjustment with this id exists for this provider in this market.

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The discount has no offer text to translate.

Set a payment adjustment translation

PUT write_markets + write_translations

Translate an online payment discount's offer texts.

Translatable fields are offer_label (up to offer_label_max_length characters), offer_conditions and offer_note (up to offer_text_max_length characters each). Send an empty string to remove a translation. Translate only a text the discount has. A write waits at most 2 seconds for other translation writes of the same item or of a clashing name or slug (for example a translation CSV import writing the same language); writes of other items, types and languages never wait. A row or call that fails with TRANSLATION_WRITE_BUSY (HTTP 503) saved nothing: send it again after error.details.retry_after_seconds (the call's Retry-After header says the same). Every row or call either saved or reports an error; none is left in an unknown state.

Path parameters

Name Type Description
marketId required uuid

Market id.

Example: 9a1f2c3d-4e5f-6789-abcd-ef0123456789
bindingId required uuid

Connected payment binding id.

Example: 5b2e8d90-1234-4678-9abc-def012345678
ruleId required uuid

Payment adjustment id.

Example: 6b2e8d90-1234-4678-9abc-def012345678
locale required string

Enabled non-default store locale.

Example: fr

Headers

Name Type Description
Authorization required string

Bearer Store API token.

Idempotency-Key string

Optional key for this translation write. Reuse it only with the same payload when repeating the request.

Body parameters

Name Type Description
translations required object

Field-keyed translation values: offer_label, offer_conditions, offer_note.

Example: {"offer_label": "5 % Rabatt mit UPI", "offer_note": "Wird an der Kasse automatisch abgezogen"}

Errors

  • 400 STORE_API_INVALID_REQUEST_BODY

    marketId must be a valid UUID.

  • 404 PAYMENT_ADJUSTMENT_NOT_FOUND

    No adjustment with this id exists for this provider in this market.

  • 400 TRANSLATION_LOCALE_NOT_ENABLED

    Locale is not enabled for this store.

  • 400 TRANSLATION_DEFAULT_LOCALE_FORBIDDEN

    Translations cannot target the store's default locale.

  • 400 TRANSLATION_RESOURCE_ID_NOT_IN_STORE

    The discount has no offer text to translate.

  • 400 STORE_API_INVALID_REQUEST_BODY

    Request body must be a JSON object containing only documented fields.

  • 400 TRANSLATION_FIELD_NOT_TRANSLATABLE

    Only offer_label, offer_conditions and offer_note are translatable for online payment discounts.

  • 400 TRANSLATION_FIELD_VALUE_TOO_LONG

    A translated text is longer than its limit: offer_label_max_length for the label, offer_text_max_length for the conditions and note.

  • 400 TRANSLATION_STAGING_INVALID_CONTROL_CHARS

    A translated text contains unsupported control characters.

  • 503 TRANSLATION_WRITE_BUSY

    Other translation writes held the item or a clashing name or slug for more than 2 seconds; nothing was saved. Send the request again after error.details.retry_after_seconds (also the Retry-After header).

  • 400 STORE_API_BODY_PROPERTY_UNKNOWN

    The body has a property this request does not accept. The message and error.details.properties list the allowed and required properties (nested for each object or list of objects).

  • 400 STORE_API_BODY_PROPERTY_INVALID

    A body property has the wrong type (error.details.expected_type). The message and error.details.properties list the allowed and required properties.