Retrieve Controls

Added Ability to Retrieve Client/SubClient TabaControl Configurations

Restricted Usage And Subject To Change

📘

TabaControl is a Pilot API

If you would like to participate in our TabaControl Pilot, reach out to your TabaPay contact. All AML controls will be set/changed by talking with your TabaPay contact. Then the following API resources will programmatically include information as to the status of your Controls. This Pilot will begin soon!

URL

https://<FQDN>/v2/clients/<ClientID>_<SubClientID>?Controls

Path Parameters:

  • FQDNFQDN - Replace FQDN with the appropriate domain. Ensure the domain you're using is consistent with the environment you're testing in (sandbox, production, etc.)
  • ClientIDClientID - Your unique 22-character string issued during onboarding. This value is used in your URLs for TabaPay APIs. For questions on what string to use, ask TabaPay support.
  • SubClientIDSubClientID - A 4, 6, or 8-digit value, specifying a program under a client. If you're unsure what value to use, ask TabaPay support. You may need to append this value in your API URL

Query Parameters

  • Controls

HTTP Method: GET


Request Data

None


Response Data

Only additional JSON fields are shown

JSON Name Value Description Status Code
200 Other
SC Integer
3-digit code
HTTP Status Code O
EC String
1 or 8 characters
Internal Error Code O
EM String Error Message O
panLimits object PAN Amount Limits (840 Currency) O
pull object PAN Pull Limits
Present Only If Configured for PAN Pull Limits
O
oneDay String
Amount
Approximate 1-Day pull Dollar Limit
Present Only If Configured for 1-day PAN pull limit
O
threeDay String
Amount
Approximate 3-Day pull Dollar Limit
Present Only If Configured for 3-day PAN pull limit
O
sevenDay String
Amount
Approximate 7-Day pull Dollar Limit
Present Only If Configured for 7-day PAN pull limit
O
thirtyDay String
Amount
Approximate 30-Day pull Dollar Limit
Present Only If Configured for 30-day PAN pull limit
O
push object PAN Push Limits
Present Only If Configured for PAN Push Limits
O
oneDay String
Amount
Approximate 1-Day push Dollar Limit
Present Only If Configured for 1-day PAN push limit
O
threeDay String
Amount
Approximate 3-Day push Dollar Limit
Present Only If Configured for 3-day PAN push limit
O
sevenDay String
Amount
Approximate 7-Day push Dollar Limit
Present Only If Configured for 7-day PAN push limit
O
thirtyDay String
Amount
Approximate 30-Day push Dollar Limit
Present Only If Configured for 30-day PAN push limit
O
panRetries object PAN Retry Limits O
groupA object Group A Retry Controls
Present Only If Configured for GroupA Retry Controls
O
count String
Integer
Number of Consecutive Group A Response Codes before taking action
action String
1-character
Action Taken once count is breached
  • L: Lock
  • R: Report
time String Amount of time action is taken once count is breached
Present Only If action is L
O
groupB object Group B Retry Controls
Present Only If Configured for Group B Retry Controls
O
count String
Integer
Number of Consecutive Group B Response Codes before taking action
action String
1-character
Action Taken once count is breached
  • L: Lock
  • R: Report
time String Amount of time action is taken once count is breached
Present Only If action is L
transactionLimits object 840 Currency
pull String
Amount
Pull Transaction Limit
push String
Amount
Push Transaction Limit
dailyLimits object 840 Currency
pull String
Amount
Approximate Daily Pull Limit
push String
Amount
Approximate Daily Push Limit
currentPositions object 840 Currency
pull String
Amount
Approximate Daily Pull Position
push String
Amount
Approximate Daily Push Position