Accounts and Cards

Set Account Feature

Changed on

Use the Set Account Feature endpoint to set or modify specified attributes of a customer account.

  • When enabling and disabling fraud rules (featureType: 14), keep in mind that if you pass featureValue: Y and do not pass endDate, the end date is set to 3000-01-01, meaning that fraud rules are suspended indefinitely. To update the timespan for fraud-rule suspension, pass featureValue: Y and the new start and/or end date-times. To immediately re-enable fraud rules, pass featureValue: N. When featureValue: N, the date fields are ignored.
  • When you change account features 20, 21 or 22, you can arrange with SoFi Tech Solutions to receive the <a href="ref:api-reference-events-api-account-feature-change" target="_blank">ACFC: account_feature_change</a> event message. [block:callout] { "type": "info", "title": "Note", "body": "Feature types 20, 21, and 22 are mutually exclusive. Only one can be set to Y at a time." } [/block]
post/setAccountFeature

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/setAccountFeature
  • Auth
    none declared

Request body application/x-www-form-urlencoded

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"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

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"

accountNostring required

The <glossary:PRN>, <glossary:PAN> or <glossary:CAD> of the account. Pattern: PAN, PRN, or CAD Example: "074103447228"

featureTypeinteger required

Consult the featureType column in the <a href="ref:api-reference-set-account-feature-values" target="_blank">Set Account Feature Values</a> table for valid values. Pattern: Integer Example: 3

featureValuestring nullable

Consult the featureValue column in the <a href="ref:api-reference-set-account-feature-values" target="_blank">Set Account Feature Values</a> table for valid values. Pattern: As specified in the featureValue column Example: Y

startDatestring date-time nullable

The starting date-time for the date range. Default: current date-time Pattern: YYYY-MM-DD hh:mm:ss Example: "2016-01-01 10:10:15"

endDatestring date-time nullable

The ending date-time for the date range; must be equal to or later than startDate. Default: 3000-01-01 00:01:00 Pattern: YYYY-MM-DD hh:mm:ss Example: "2016-02-01 10:10:10"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "featureType": 3,
  "featureValue": "Y",
  "startDate": "2016-01-01 10:10:15",
  "endDate": "2016-02-01 10:10:10"
}

Response

status_codeinteger nullable required

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

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes