Get Federal Benefit Enrollments

post https://api-{corename}.{env}.gpsrv.com/intserv/4.0/getFbEnrollments

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

Form Data

apiLogin

string

required

Web service username, as provided by Galileo.
Pattern: Max 50 characters
Example: "AbC123-9999"

apiTransKey

string

required

Web service password, as provided by Galileo.
Pattern: Max 15 characters
Example: "4sb62fh6w4h7w34g"

providerId

int32

required

Galileo-issued provider identifier.
Pattern: Max 10 digits
Example: 9999

transactionId

string

required

1 to 60

A unique provider-generated ID to identify this API call. A UUID is preferred.
Pattern: 60 characters or less
Example: "9845dk-39fdk3fj3-4483483478"

accountNo

string

required

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

fbeDda

string | null

Defaults to null

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

agencyType

string | null

Defaults to null

The type of agency that is providing the benefit. See the Federal Benefit Enrollment Agency Types enumeration for valid values.
Pattern: String
Example: "SOCIAL SECURITY"

status

string | null

Defaults to null

Specifies the state of the federal benefits enrollment. See the Federal Benefit Enrollment Statuses enumeration for valid values.
Pattern: One character
Example: "B"

beneficiarySsn

string | null

Defaults to null

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

beneficiaryFirstName

string | null

Defaults to null

Account holder's first name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Ed"

beneficiaryLastName

string | null

Defaults to null

Cardholder's last name
Account holder's last name. Special character support.
Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (')
Example: "Harley"

enrolledFrom

string | null

Defaults to null

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

enrolledTo

string | null

Defaults to null

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

submittedFrom

string | null

Defaults to null

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

submittedTo

string | null

Defaults to null

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

notedFrom

string | null

Defaults to null

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

notedTo

string | null

Defaults to null

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

Headers

response-content-type

string

Defaults to json

Use xml or json to specify the type of response. The default value is xml. Use this instead of the standard accept header.

Response

Response body

object

status_code

int32 | null

required

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

status

string | null

required

The condition of a process or response

processing_time

float | null

required

The time elapsed in processing the transaction

echo

object | null

required

A structure that contains transaction ID information

transaction_id

string | null

required

An ID that represents an API transaction

provider_timestamp

date-time | null

required

Store a related timestamp for reporting and troubleshooting purposes

provider_transaction_id

string | null

required

Secondary transaction identifier (generated by a provider)

system_timestamp

date-time | null

required

A system generated timestamp

rtoken

string | null

required

A Galileo-generated ID used for tracking

errors

array of strings

A list of errors generated while the request was processed

errors

response_data

object | null

required

A structure for the response data. It can be empty but usually will contain information.

found

int32

required

The number of federal benefit enrollments found for the account

results

array of objects

required

A list if enrollment objects

results*

object

fbe_status_id

string

required

Federal benefit enrollment ID

pmt_ref_no

string

required

Galileo-generated account number. Also called the PRN.

fbe_dda

string

required

PRN for the federal benefit enrollment DDA

status

string

required

The status of the enrollment. See Federal Benefit Enrollment Statuses.

enrolled_date

date

required

Date when the federal benefit enrollment record was created

submitted_date

date

required

Date when the federal benefit enrollment record was last submitted

noted_date

date | null

required

Shows either the date of the last deposit or the last confirmed date

product_description

string | null

Description of the product

card_status

string | null

required

The status of the card

beneficiary_ssn

string | null

required

The SSN of the beneficiary

beneficiary_first_name

string | null

required

The first name of the beneficiary

beneficiary_last_name

string | null

required

The last name of the beneficiary

original_pmt_ref_no

string | null

PRN for the input account associated with the federal benefit DDA

status_description

string | null

required

A description of the status

benefit_type

string | null

required

The federal benefit enrollment agency type

recipient_type

string | null

required

Description of the federal benefit enrollment agency type specified in the benefit_type field

Status codes

See Global Response Statuses for status codes that are common across endpoints.

Language

URL


xxxxxxxxxx
17
1
curl --request POST \
2
     --url https://api-corename.env.gpsrv.com/intserv/4.0/getFbEnrollments \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded' \
5
     --header 'response-content-type: json' \
6
     --data fbeDda=null \
7
     --data agencyType=null \
8
     --data status=null \
9
     --data beneficiarySsn=null \
10
     --data beneficiaryFirstName=null \
11
     --data beneficiaryLastName=null \
12
     --data enrolledFrom=null \
13
     --data enrolledTo=null \
14
     --data submittedFrom=null \
15
     --data submittedTo=null \
16
     --data notedFrom=null \
17
     --data notedTo=null

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/xml