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. |
| limits | array | ? | This parameter is used to override limits (min-max) for the specific payment methods, under 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
}
]
}
}Limits array description:
This property will be used to override the customer's limit in the Cashier session. This property will contain an array of elements with the following scheme:
- payment_method -
string: Key of the payment method. Usenullfor a global rule (applied to all methods). Note: Only one object can have anullvalue. - processing_currencies –
object(required): A map where each key is a currency code (string, ISO 4217), and the value is an object with:- min_amount –
integer: Minimum allowed amount in minor units. - max_amount –
integer: Maximum allowed amount in minor units.
- min_amount –
- use_as_base -
string(optional): Currency code that acts as a reference point for calculating limits for other currencies. The values from this currency will be used to calculate 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
}
}
}
]
}
}