Create Federal Benefit Enrollment

post

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

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.

📘
Note
This endpoint automatically creates a secondary account for benefits deposits that shares its balance with the primary account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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

^$|^([0-9]{12}|[0-9]{16})$

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

location

string

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"

locationType

int32

enum

required

0=Galileo Location ID
1=Partner Location ID
Pattern: 0 or 1
Example: 1

Allowed:

recipientType

int32

required

0 to 9

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

firstName

string

required

length between 2 and 30

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

lastName

string

required

length between 2 and 30

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

ssn

string

required

^[\d]{9}$

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

agencyType

string

required

^[A-Z\/\s]

One of several defined agency types.
Pattern: See the Federal Benefit Enrollment Agency Types table in Enumerations.
Example: "SOCIAL SECURITY"

alerts

int32 | null

enum

Defaults to 0

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

Allowed:

agentId

int32 | null

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

middleName

string | null

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

Headers

response-content-type

string

enum

Defaults to json

Use this header instead of the standard accept header to specify the response format.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

URL

Loading…

Response

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

application/json

application/xml

default