These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

User Preference Request Parameters

📘

Data Attribute Reference

Data Type

  • A: Alphabet
  • AN: Alphanumeric
  • C: Characters
  • B: Boolean
  • D: Decimal
  • N: Numeric

Mandatory attributes

  • M: Mandatory
  • C: Conditional
  • O: Optional

Parameter

Data Type

Mandatory

Description

paymentToken

C 255

M

Payment token ID

clientID

C 255

O

Unique client ID

This ID will be created when the UI SDK initializes and stores in-app preferences.

Formula :
Get UUID

locale

C 10

O

API response localization

Based on ISO 639 codes

 

Important:
If locale is empty, the API will respond based on payment token locale.

If locale has been set, API will respond with requested locale.

If the clientID exists, the API will respond with the user's preferred locale