Get Auth Control

post

https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getAuthControl

Use the Get Auth Control endpoint to retrieve the velocity control details and their control IDs—at either the product level or account level, with or without MCC ranges.

See Retrieving velocity limits for instructions on using this endpoint.

Recipes

Get Auth Control response for product

Open Recipe

Get Auth Control response for account

Open Recipe

Status codes

See Global Response Statuses for status codes that are common across endpoints.

The table below lists status codes that apply to this specific endpoint.

Status code	Description
600-01	No Account Level Auth Control has been set for this acct.
600-02	Product is not configured for auth controls.
600-03	Calculations on the current usages and available balances of auth controls fail due to unknown period type of auth controls.
600-04	No velocity ALCs exist for the provided beginningMcc or endMcc arguments. Please provide a valid beginning MCC or end MCC value.

Form Data

apiLogin

string

required

Web service username, as provided by SoFi Tech Solutions.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by SoFi Tech Solutions.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

transactionId

string

required

1 to 60

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred.
Pattern: Maximum 60 characters
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string | null

^.+$

The PRN for the account. Do not use the CAD or PAN. Pass this value to retrieve all of the account-level velocity controls for this account. If this parameter is not populated then prodId must be populated.
Pattern: PRN (12-digit numeric string)
Example: "344101254935"

controlId

int32 | null

The system-generated identifier for the auth-level velocity control. When this parameter is populated then either prodId or accountNo must also be populated.
Pattern: Integer, max 18 digits
Example: 102

prodId

int32 | null

The system-generated identifier for the product. Pass this value to retrieve all of the product-level velocity controls for this product. If this parameter is not populated then accountNo must be populated.
Pattern: Integer
Example: 15293

beginningMcc

int32 | null

1 to 1000000000000000000

The start of the MCC range for the control. If this parameter is populated, then endMcc and accountNo must be populated.
Pattern: 3–4 digit integer, no leading zero
Example: 3000

endMcc

int32 | null

1 to 1000000000000000000

The end of the MCC range for the control. If this parameter is populated, then beginningMcc and accountNo must be populated.
Pattern: 3–4 digit integer, no leading zero
Example: 3999

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml

Status codes

default