GAgalileo-ft
Federal Benefit Enrollment

Get Federal Benefit Enrollments

Use the Get Federal Benefit Enrollments endpoint to retrieve information on the federal benefit enrollments of the specified account.

post/getFbEnrollments

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/getFbEnrollments
  • 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: PRN or PAN Example: "074103447228"

fbeDdastring nullable

The PRN of the federal benefits enrollment <glossary:DDA>. Pattern: PRN Example: "074103447228"

agencyTypestring nullable

The type of agency that is providing the benefit. See the <a href="ref:api-reference-federal-benefit-enrollment-agency-types" target="_blank">Federal Benefit Enrollment Agency Types</a> enumeration for valid values. Pattern: String Example: "SOCIAL SECURITY"

statusstring nullable

Specifies the state of the federal benefits enrollment. See the <a href="ref:api-reference-federal-benefit-enrollment-statuses" target="_blank">Federal Benefit Enrollment Statuses</a> enumeration for valid values. Pattern: One character Example: "B"

beneficiarySsnstring nullable

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

beneficiaryFirstNamestring nullable

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"

beneficiaryLastNamestring nullable

Cardholder's last name 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"

enrolledFromstring nullable

Date enrollment started. Pattern: YYYY-MM-DD Example: "2016-01-01"

enrolledTostring nullable

Date enrolled to. Pattern: YYYY-MM-DD Example: "2016-01-01"

submittedFromstring nullable

Date submitted from. Pattern: YYYY-MM-DD Example: "2016-01-01"

submittedTostring nullable

Date submitted to. Pattern: YYYY-MM-DD Example: "2016-01-01"

notedFromstring nullable

Date noted from. Pattern: YYYY-MM-DD Example: "2016-01-01"

notedTostring nullable

Date noted to. Pattern: YYYY-MM-DD Example: "2016-01-01"

enrReturnedFromstring nullable

Date enr_returned from. Pattern: YYYY-MM-DD Example: "2016-01-01"

enrReturnedTostring nullable

Date enr_returned to. Pattern: YYYY-MM-DD Example: "2016-01-01"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "fbeDda": "074103447228",
  "agencyType": "SOCIAL SECURITY",
  "status": "B",
  "beneficiarySsn": "123456789",
  "beneficiaryFirstName": "Ed",
  "beneficiaryLastName": "Harley",
  "enrolledFrom": "2016-01-01",
  "enrolledTo": "2016-01-01",
  "submittedFrom": "2016-01-01",
  "submittedTo": "2016-01-01",
  "notedTo": "2016-01-01",
  "enrReturnedTo": "2016-01-01"
}

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

Example response

{
  "response_data": {
    "results": [
      {
        "enr_return_code": "R47"
      }
    ]
  }
}

Changes

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