Authorization configurations

Update authorization configuration by program

Update the authorization configuration at the program level. This operation updates the entire configuration. Therefore, all fields must be sent to avoid data loss.

put/v1/config/program/{programId}

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v1/config/program/{programId}
  • Auth
    none declared. Required headers: x-tenant

Path parameters

programIdinteger required
Example:6912345

Program ID

Headers

x-tenantstring required

Tenant ID

Request body

use_anti_fraud_response_codeboolean

Flag indicates whether we should use the response code sent in anti-fraud.

zero_balance_urlstring

Indicates that it’s a Zero Balance flow, so the URL to call the customer’s service is informed. NOTE: This is only required for Zero balance.

should_use_anti_fraud_decisionboolean

Flag indicates whether anti-fraud decisions should be used.

approve_anti_fraud_unavailableboolean

If set to true when anti-fraud is unavailable, the anti-fraud check is marked as APPROVED. If set to false, it is marked as REJECTED.

enabled_partial_authorizationboolean

By default, authorizations don’t validate partial authorization, but if this property is enabled, it allows the platform to process partial authorizations for a given org/program/account. NOTE: This property also depends on the merchant, as it is necessary for the merchant to be able to partially authorize.

disable_dccboolean

This setting indicates whether or not the program allows dynamic currency conversion (DCC) transactions. By default, every program allows DCC transactions. In case it's necessary to block this type of transaction, the configuration must be set to true.

deny_all_authorizationsboolean

Flag indicates whether authorizations should be denied. This is useful for cases where a product is deprecated or during a migration process.

use_settlement_from_networkboolean

By default, in clearing flow for international purchases, the authorizations use the same settlement amount of authorization (online flow). Setting this flag to truemeans the system will use the settlement amount from the clearing message, which can be different from authorization.

use_rates_fee_modelsboolean

Flag indicates whether rate fee models should be used.

call_anti_fraud_when_cancellingboolean

Flag indicates whether the anti-fraud API should be called during cancellation.

days_to_cancel_pre_authorizationinteger

Number of days to cancel pre-authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_authorizationinteger

Number of days to cancel authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_pre_authorization_migrationinteger

Number of days to cancel migrated pre-authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_authorization_migrationinteger

Number of days to cancel migrated authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

always_call_ledger_rulesboolean

Flag indicates whether Ledger API and Rules API should be always called, even when the authorization has already been denied.

Example request

{
  "use_anti_fraud_response_code": true,
  "zero_balance_url": "http://zerobalanceurl",
  "should_use_anti_fraud_decision": true,
  "approve_anti_fraud_unavailable": true,
  "enabled_partial_authorization": true,
  "disable_dcc": true,
  "deny_all_authorizations": true,
  "use_settlement_from_network": true,
  "use_rates_fee_models": true,
  "call_anti_fraud_when_cancelling": true,
  "days_to_cancel_pre_authorization": 5,
  "days_to_cancel_authorization": 5,
  "days_to_cancel_pre_authorization_migration": 5,
  "days_to_cancel_authorization_migration": 5,
  "always_call_ledger_rules": true
}

Response

Updated successfully

use_anti_fraud_response_codeboolean

Flag indicates whether we should use the response code sent in anti-fraud.

zero_balance_urlstring

Indicates that it’s a Zero Balance flow, so the URL to call the customer’s service is informed. NOTE: This is only required for Zero balance.

should_use_anti_fraud_decisionboolean

Flag indicates whether anti-fraud decisions should be used.

approve_anti_fraud_unavailableboolean

If set to true when anti-fraud is unavailable, the anti-fraud check is marked as APPROVED. If set to false, it is marked as REJECTED.

enabled_partial_authorizationboolean

By default, authorizations don’t validate partial authorization, but if this property is enabled, it allows the platform to process partial authorizations for a given org/program/account. NOTE: This property also depends on the merchant, as it is necessary for the merchant to be able to partially authorize.

disable_dccboolean

This setting indicates whether or not the program allows dynamic currency conversion (DCC) transactions. By default, every program allows DCC transactions. In case it's necessary to block this type of transaction, the configuration must be set to true.

deny_all_authorizationsboolean

Flag indicates whether authorizations should be denied. This is useful for cases where a product is deprecated or during a migration process.

use_settlement_from_networkboolean

By default, in clearing flow for international purchases, the authorizations use the same settlement amount of authorization (online flow). Setting this flag to truemeans the system will use the settlement amount from the clearing message, which can be different from authorization.

use_rates_fee_modelsboolean

Flag indicates whether rate fee models should be used.

call_anti_fraud_when_cancellingboolean

Flag indicates whether the anti-fraud API should be called during cancellation.

days_to_cancel_pre_authorizationinteger

Number of days to cancel pre-authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_authorizationinteger

Number of days to cancel authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_pre_authorization_migrationinteger

Number of days to cancel migrated pre-authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

days_to_cancel_authorization_migrationinteger

Number of days to cancel migrated authorization. NOTE: The minimum number of days is 1 and the maximum is 60.

always_call_ledger_rulesboolean

Flag indicates whether Ledger API and Rules API should be always called, even when the authorization has already been denied.

Example response

{
  "use_anti_fraud_response_code": true,
  "zero_balance_url": "http://zerobalanceurl",
  "should_use_anti_fraud_decision": true,
  "approve_anti_fraud_unavailable": true,
  "enabled_partial_authorization": true,
  "disable_dcc": true,
  "deny_all_authorizations": true,
  "use_settlement_from_network": true,
  "use_rates_fee_models": true,
  "call_anti_fraud_when_cancelling": true,
  "days_to_cancel_pre_authorization": 5,
  "days_to_cancel_authorization": 5,
  "days_to_cancel_pre_authorization_migration": 5,
  "days_to_cancel_authorization_migration": 5,
  "always_call_ledger_rules": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.