Configure targeted auth controls.

Configure card and program level targeted spend controls

Request
Security:
path Parameters
version
required
string
Request Body schema: application/json
program_guid
string or null <uuid>

Program unique identifier. Program_guid or card_proxy are required.

card_proxy
string or null

Card identifier. Program_guid or card_proxy are required.

card_auth_limit_values
string or null

Card limit values

There are four selection options: allow_all_except allow_all block_all block_all_except

There are three different entities you can configure limits for: mcc_list - Merchant category code ex 1711 - Air Conditioning, Heating, and Plumbing Contractors mcc_list is defined as a range of mcc values. See examples merchant_name_list - Merchant name i.e. Amazon. Merchant names use value_has logic so "amazon" would select "amazon.com" or "amazon prime" or even "amazon river gift shop". See examples merchant_id_list - AKA Merchant Identification Number (MID). This is number that uniquely identifies a particular merchant. For example 784959000762203 identifies Amazon.com. This configuration merchant_id_list uses value_is logic. See examples

Examples All three configured for allow_all_except { "card_auth_target_control": { "allow_all_except": [ { "mcc_list": [ { "range": { "from": "6011", "through": "6012" } } ] }, { "merchant_id_list": [ { "value_is": ["160146000762203","020014005912000"]
} ] }, { "merchant_name_list": [ { "value_has": [ "Amazon", "Amazon Prime" ] } ] }
] } }

/// All three configured for block_all { "card_auth_target_control": { "allow_all_except": [ { "mcc_list": [ { "range": { "from": "6011", "through": "6012" } } ] }, { "merchant_id_list": [ { "value_is": ["160146000762203","020014005912000"]
} ] }, { "merchant_name_list": [ { "value_has": [ "Amazon", "Amazon Prime" ] } ] }
] } }

Two MCC ranges defined { "card_auth_target_control": { "allow_all_except": [ { "mcc_list": [ { "range": { "from": "6011", "through": "6012" } } ] }, { "mcc_list": [ { "range": { "from": "7011", "through": "7012" } } ] }, { "merchant_id_list": [ { "value_is": ["160146000762203","020014005912000"]
} ] }, { "merchant_name_list": [ { "value_has": [ "Amazon",
"Amazon Prime" ] } ] } ] } }

targeted_auth_limit_expiration
string or null <= 10 characters

Targeted card auth control expiration Date (Optional by default limit will never expire) use the ccyy-mm-dd format. Valid for card configuration only

Responses
200

Returns program details

400

Bad request

401

Unauthorized

500

Server Error

post/api/{version}/limits/cardauthcontrols
Request samples
application/json
{
  • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
  • "card_proxy": "string",
  • "card_auth_limit_values": "string",
  • "targeted_auth_limit_expiration": "string"
}
Response samples
application/json
[
  • {
    • "program_guid": "3fa0d2ea-ffcf-485d-94ed-dbf4f861ad2f",
    • "card_proxy": "string",
    • "card_auth_limit_values": "string",
    • "targeted_auth_limit_expiration": "2019-08-24T14:15:22Z"
    }
]
Copyright © 2023 KeyBank & Qolo. All rights reserved.