GAgalileo-ft
Account-Level Controls

Get Auth Control

Changed on

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 <a href="doc:set-velocity-controls#retrieving-velocity-limits" target="_blank">Retrieving velocity limits</a> for instructions on using this endpoint.

post/getAuthControl

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/getAuthControl
  • Auth
    none declared

Request body application/x-www-form-urlencoded

accountNostring nullable

The <glossary:PRN> for the account. Do not use the <glossary:CAD> or <glossary: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"

apiLoginstring required

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

apiTransKeystring required

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

beginningMccinteger nullable

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

controlIdinteger nullable

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

endMccinteger nullable

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

prodIdinteger nullable

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

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

Example request

{
  "accountNo": "344101254935",
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "beginningMcc": 3000,
  "controlId": 102,
  "endMcc": 3999,
  "prodId": 15293,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

Successful response

errorsstring[]

A list of errors generated while the request was processed

processing_timenumber nullable required

The time elapsed in processing the transaction

rtokenstring nullable required

A system-generated ID used for tracking

statusstring nullable required

The condition of a process or response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

system_timestampstring date-time nullable required

A system generated timestamp

Changes

  • 1ede7567a879Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 60

    • info

      the request property format was generalized from int32 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      the request property format was generalized from int32 to no format

    • info

      added the success response with the status