GAgalileo-ft
Accounts and Cards

Complete Enrollment

Use the Complete Enrollment endpoint to finalize an incomplete enrollment that was begun by <a href="ref:post_startenrollment" target="_blank">Start Enrollment</a> or <a href="ref:post_createaccount" target="_blank">Create Account</a>. You must pass the same transactionId as the original Start Enrollment or Create Account request.

📘 Note

If this endpoint returns a status code that does not match a status code that is specific to this endpoint, it may be an enrollment status code. See <a href="ref:api-reference-enrollment-statuses" target="_blank">Enrollment Statuses</a> for more information.

post/completeEnrollment

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/completeEnrollment
  • 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"

locationstring nullable

Unique location identifier (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> endpoint depending on the value of locationType when the location was created:

  • 0 or 2 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1 Example: "a455-3483"

accountNostring

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

prodIdinteger required

A unique product identifier from SoFi Tech Solutions. If this ID is for a business product then businessName is required. Pattern: Integer Example: 501

locationType0 | 1 | 2 nullable

Type of ID in location:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Partner location ID
  • 2 — Don't validate

Pattern: Integer Example: 1

sharedBalance0 | 1 nullable

Specifies whether the secondary account will share the balance of the primary account. This parameter is required when primaryAccount is populated. Do not set this parameter to 1 when primaryAccount is not populated.

  • 0 — Do not share the balance
  • 1 — Share the balance

Pattern: Integer Example: 1

offline0 | 1 nullable

Pass 1 for an offline transaction. Pattern: Integer Example: 1

primaryAccountstring nullable

<glossary:PAN> or <glossary:PRN> of the primary account to associate this account with. Populate this parameter only when creating a secondary account. Pattern: PAN or PRN Example: "123456789012"

externalAccountIdstring nullable

User-supplied identifier that is related to an external system. This ID is stored in the system in association with this account and can be provided in the <glossary:RDF>s. Pattern: Max 30 alphanumeric characters. Lowercase only. Example: "553b45sbs"

embossLine2string nullable

Second line to emboss on the card. Pattern: <a href="ref:api-reference-special-characters#embossline2-characters" target="_blank">Supported characters</a> Example: "Scarlet Ibis Shipping"

fundingAccountNostring nullable

PRN of the <glossary:RTF> funding account. Required if prodId is an RTF spending product. Pattern: 12-digit numeric string Example: "143101204201"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "location": "a455-3483",
  "accountNo": "074103447228",
  "prodId": 501,
  "locationType": 1,
  "sharedBalance": 1,
  "offline": 1,
  "primaryAccount": "074103447228",
  "externalAccountId": "553b45sbs",
  "embossLine2": "Scarlet Ibis Shipping",
  "fundingAccountNo": "143101204201"
}

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.