GAgalileo-ft
Federal Benefit Enrollment

Create Federal Benefit Enrollment

Changed on

Use the Create Federal Benefit Enrollment endpoint to initiate the process for the specified customer to receive U.S. federal benefit funds via ACH deposit. All enrollments that you initiate with this endpoint are queued into a batch file that is sent regularly (usually daily) to the federal government for processing.

[block:callout]

{ "type": "info", "title": "Note", "body": "This endpoint automatically creates a secondary account for benefits deposits that shares its balance with the primary account." } [/block]

post/createFbEnrollment

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

locationstring required

Unique location identifier; see location types. Pattern: Must be a number if type is 0; Must be less than 15 characters if type is 1. Example: "a455-3483"

locationType0 | 1 | 2 required

0=SoFi Tech Solutions location ID 1=Partner Location ID Pattern: 0 or 1 Example: 1

recipientTypeinteger required

Specifies whether the owner of the account in accountNo is a direct recipient or a beneficiary:

  • 0 — Direct recipient
  • 1 — Beneficiary

Pattern: Integer Example: 1

firstNamestring required

Account holder's first name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Ed"

lastNamestring required

Account holder's last name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Harley"

ssnstring required

The Social Security number of the direct recipient of the disbursement. Pattern: 9-digit Social Security number, no hyphens Example: "123456789"

agencyTypestring required

One of several defined agency types. Pattern: See the <a href="ref:api-reference-federal-benefit-enrollment-agency-types" target="_blank">Federal Benefit Enrollment Agency Types</a> table in Enumerations. Example: "SOCIAL SECURITY"

alerts0 | 1 nullable

Specifies whether to send alerts regarding the enrollment process. Pattern: Integer Example: 1

agentIdinteger nullable

Identifier of the agent, for use in transaction reporting and tracking. Pattern: Integer Example: 109405

middleNamestring nullable

Middle name of the beneficiary.Middle names are not used in ENR transactions, but they are included here for parity between the Account Management and Federal Benefit Enrollment data models. Pattern: String Example: James

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "location": "a455-3483",
  "locationType": 1,
  "recipientType": 1,
  "firstName": "Ed",
  "lastName": "Harley",
  "ssn": "123456789",
  "agencyType": "SOCIAL SECURITY",
  "alerts": 1,
  "agentId": 109405,
  "middleName": "James"
}

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