Objects Session Configuration object

• STRUCTURE

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

STRUCTURE

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

Wallet Data object description:
The session_configuration.wallet_data property contains a list of payment methods along with values to predefine during the Cashier session.

The object includes the following parameters:

• key – The field name, as defined in the payment method configuration.
• value – The value used to prefill the field in the Cashier.
• is_editable – Indicates whether the field value should be editable in the Cashier. Possible values: 1/0.
• is_masked – Indicates whether the field value should be masked in the 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
      }
    ]
  }
}

Limits array description:
This property is used to override the customer's limits during the Cashier session. It accepts an array of objects following the structure below:

• payment_method – string: The key of the payment method. Use null to define a global rule (applies to all methods).
  Note: Only one object in the array can have a null value.

• processing_currencies – object (required): A map where each key is a currency code (string, ISO 4217), and the value is an object containing:

  • min_amount – integer: The minimum allowed amount (in minor units).
  • max_amount – integer: The maximum allowed amount (in minor units).

• use_as_base – string (optional): A currency code that serves as the base currency for calculating equivalent limits in other currencies.
  The limit values from this currency will be used to derive limits in other currencies.

See an example of the object:

{
    ...,
    "session_configuration": {
        ...,
        "limits": [
            {
                "payment_method": null,
                "processing_currencies": {
                    "USD": {
                        "min_amount": 500,
                        "max_amount": 100000
                    },
                    "EUR": {
                        "min_amount": 450,
                        "max_amount": 95000
                    }
                },
                "use_as_base": "USD"
            },
            {
                "payment_method": "neteller",
                "processing_currencies": {
                    "EUR": {
                        "min_amount": 1000,
                        "max_amount": 200000
                    }
                }
            }
        ]
    }
}