GAgalileo-ft
Accounts and Cards

Set User-Defined Account Field

Use the Set User-Defined Account Field endpoint to create or update custom data elements on an account. There is no technical limit on the number of fields that you can add. See <a href="doc:about-accounts#user-defined-account-fields" target="_blank">User-defined account fields</a> in About Accounts for more information.

  • fieldId — Provide an identifier for the field. This identifier must be unique only to the account.
  • fieldValue — Provide the value for that field.

These fields are visible in the <glossary:CST> on the account's landing page.

post/setUserDefinedAccountField

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/setUserDefinedAccountField
  • 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> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

fieldIdstring required

Field identifier or key name. Pattern: 1–15 alphanumeric characters Example: "MYACCTID"

fieldValuestring required

Field value. Pattern: 1–175 characters Example: "48547537447-ABCD"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "fieldId": "MYACCTID",
  "fieldValue": "48547537447-ABCD"
}

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

No recorded changes to this operation across all 2 revisions of this API.