Praxis Wiki logo

Objects Session Configuration object


The object will contain overriding configuration rules for this session attempt.

STRUCTURE

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable Type Description
allow_card_brands array ? This parameter contains the list of allowed card brands for the client in the Cashier session.
Allowed values:
- AMEX
- Dankort
- DinersClub
- Discover
- Electron
- Forbrugsforeningen
- JCB
- Maestro
- MasterCard
- Mir
- Unionpay
- VISA
Note: The same value of the card brand cannot be present in both parameters allow_card_brands and exclude_card_brands at the same time.
exclude_card_brands array ? This parameter contains the list of card brands that should be excluded from the list of supported card brands for the client in the Cashier session.
Allowed values:
- AMEX
- Dankort
- DinersClub
- Discover
- Electron
- Forbrugsforeningen
- JCB
- Maestro
- MasterCard
- Mir
- Unionpay
- VISA
Note: The same value of the card brand cannot be present in both parameters allow_card_brands and exclude_card_brands at the same time.
wallet_data <Object> ? This object contains the list of payment methods with the values of additional fields that will be used for the Cashier session.

Wallet Data object description:
The session_configuration.wallet_data property contains the list of the payment methods with the values for predefining in the Cashier session.
The object contains the following parameters:

  • key - the field name as per payment method configuration
  • value - the value for predefining the field in Cashier
  • is_editable - the property that indicates if the value should be editable in Cashier. Possible values - 1/0
  • is_masked - the property that indicates if the value should be masked in Cashier. Possible values - 1/0

See an example of the value for the pix and skill payment methods:

{
  "wallet_data": {
    "pix": [
      {
        "key": "cpf",
        "value": "231.002.999-00",
        "is_editable": 0,
        "is_masked": 1
      },
      {
        "key": "pix_key_type",
        "value": "email",
        "is_editable": 1,
        "is_masked": 0
      },
      {
        "key": "pix_value",
        "value": "[email protected]",
        "is_editable": 1,
        "is_masked": 0
      }
    ],
    "skrill": [
      {
        "key": "country",
        "value": "CY",
        "is_editable": 1,
        "is_masked": 0
      },
      {
        "key": "email",
        "value": "[email protected]",
        "is_editable": 0,
        "is_masked": 0
      }
    ]
  }
}