Manage FBE

Manage FBE

The Manage FBE (Federal Benefits Enrollement) API allows to Create, Change FBE Status, and Update FBE Status of card holders enrollment.

Input Parameters:

Name
Required
Definition
Comments

BenefitType

Y

Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)

CardNumber

C

Format: Numeric, 16

Required based on CardParameterType value (CardNumber or RPID). Relevant for ManageFBEOperationType values of: Create, ChangeStatus

CardParameterType

Y

Relevant for ManageFBEOperationType values of: Create

CheckFBOFirstName

N

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Create

CheckFBOLastName

N

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Create

CheckFirstName

N

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Create

CheckLastName

N

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Create

EarlyAccess

N

Format: Y/N

Relevant for ManageFBEOperationType values of: Create

FBEID

C

Format: FBEDetailRecordId - for internal uses

May be required based on FBEParametersType param. Relevant for ManageFBEOperationType values of: ChangeStatus, Update

FBEStatus

N

Format options: Closed list of values (1 char): Submitted (G) Confirmed (C) Error (X) Updated (U) Returned (R) (Enrolled (E) - Initial Status)

Relevant for ManageFBEOperationType values of: ChangeStatus

FBESubmittedFirstName

Y

Format: Alphanumeric, 1-7

Relevant for ManageFBEOperationType values of: Create

FBESubmittedLastName

Y

Format: Alphanumeric, 1-15

Relevant for ManageFBEOperationType values of: Create

ManageFBEOperationType

Y

Format options: Create ChangeStatus Update

Relevant for ManageFBEOperationType values of: Create, ChangeStatus, Update

ManageFBEParameterType

Y

Format options: FBEID (required FBEID Parameter) CardNumberSSNBenefit (required Card Number, SSN and BenefitType parameters)

Relevant for ManageFBEOperationType values of: ChangeStatus, Update

NewBenefitType

Y

Format options: SI (SSI - Suppl. Security Income) SS (Soc Sec - Social Security) BL (Black Lung) IA (Bureau of Indian Affairs) CR (Civil Service Retirement) CS (Civil Service Survivor) MA (Mil. Active) MC (Mil. Civilian Pay) MP (Mil. Pension/Retire) MS (Mil. Survivor) RR (Railroad Retirement) RU (Railroad Unempl. / Sickness) VC (Veterans Compensation/Pension) VE (Veterans Edu. And Sel. Reserve) VM (Veterans Education MGIB) VL (Veterans Life Insurance) VV (Veterans Vocational Rehabilitation)

NewCheckFBOFirstName

Y

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Update

NewCheckFBOLastName

Y

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Update

NewCheckFirstName

Y

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Update

NewCheckLastName

Y

Format: Alphanumeric, 2-20

Relevant for ManageFBEOperationType values of: Update

NewFBESubmittedFirstName

Y

Format: Alphanumeric, 1-7

Relevant for ManageFBEOperationType values of: Update

NewFBESubmittedLastName

Y

Format: Alphanumeric, 1-15

Relevant for ManageFBEOperationType values of: Update

NewSSN

Y

Format: Numeric, 9 Description: SSN of Beneficiary

Relevant for ManageFBEOperationType values of: Update

RPID

C

Format: Numeric, 1-19

Required based on CardParameterType value (CardNumber or RPID), Relevant for ManageFBEOperationType values of: Create

SSN

Y

Format: Numeric, 9 Description: SSN of Beneficiary

Required in Create request. May be required in Update request & Update FBE Status request based on FBEParametersType param

Output Parameters:

XML Samples

Input XML

<?xml version="1.0"?>
<PraxellXMLRequest>
  <AuthenticationDetails>
    <UserName>Adx</UserName>
    <UserPassword>1q2w3e4r</UserPassword>
    <ClientSourceIP>NA</ClientSourceIP> 
 </AuthenticationDetails>;
  <ServiceDetails>
    <UniqueRequestId>4129308</UniqueRequestId>
    <ServiceName>ManageDailyLimit</ServiceName>
  </ServiceDetails>
  <Origin>
    <OriginType>ExtAPI</OriginType>
  </Origin>
  <ServiceParams>
<BenefitType>Y</BenefitType>
  <CardNumber>C</CardNumber>
  <CardParameterType>Y</CardParameterType>
  <CheckFBOFirstName>N</CheckFBOFirstName>
  <CheckFBOLastName>N</CheckFBOLastName>
  <CheckFirstName>N</CheckFirstName>
  <CheckLastName>N</CheckLastName>
  <EarlyAccess>N</EarlyAccess>
  <FBEID>C</FBEID>
  <FBEStatus>N</FBEStatus>
  <FBESubmittedFirstName>Y</FBESubmittedFirstName>
  <FBESubmittedLastName>Y</FBESubmittedLastName>
  <ManageFBEOperationType>Y</ManageFBEOperationType>
  <ManageFBEParameterType>Y</ManageFBEParameterType>
  <NewBenefitType>Y</NewBenefitType>
  <NewCheckFBOFirstName>Y</NewCheckFBOFirstName>
  <NewCheckFBOLastName>Y</NewCheckFBOLastName>
  <NewCheckFirstName>Y</NewCheckFirstName>
  <NewCheckLastName>Y</NewCheckLastName>
  <NewFBESubmittedFirstName>Y</NewFBESubmittedFirstName>
  <NewFBESubmittedLastName>Y</NewFBESubmittedLastName>
  <NewSSN>Y</NewSSN>
  <RPID>C</RPID>
  <SSN>Y</SSN>
  </ServiceParams>
</PraxellXMLRequest>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ManageDailyLimit</ServiceName>
    <SessionId>12345678901234567</SessionId>
    <StatusCode>0</StatusCode>
    <StatusName>StatusOK</StatusName>
    <StatusDescription>NA</StatusDescription>
    <ServiceDate>2023-06-26 20:32:45</ServiceDate>
    <ServiceId>12345678901234567</ServiceId>
  </ResponseDetails>
  <ResponseParams>
    <BenefitType>Y</BenefitType>
    <CardNumber>C</CardNumber>
    <CardParameterType>Y</CardParameterType>
    <CheckFBOFirstName>N</CheckFBOFirstName>
    <CheckFBOLastName>N</CheckFBOLastName>
    <CheckFirstName>N</CheckFirstName>
    <CheckLastName>N</CheckLastName>
    <EarlyAccess>N</EarlyAccess>
    <FBEID>C</FBEID>
    <FBEStatus>N</FBEStatus>
    <FBESubmittedFirstName>Y</FBESubmittedFirstName>
    <FBESubmittedLastName>Y</FBESubmittedLastName>
    <ManageFBEOperationType>Y</ManageFBEOperationType>
    <ManageFBEParameterType>Y</ManageFBEParameterType>
    <NewBenefitType>Y</NewBenefitType>
    <NewCheckFBOFirstName>Y</NewCheckFBOFirstName>
    <NewCheckFBOLastName>Y</NewCheckFBOLastName>
    <NewCheckFirstName>Y</NewCheckFirstName>
    <NewCheckLastName>Y</NewCheckLastName>
    <NewFBESubmittedFirstName>Y</NewFBESubmittedFirstName>
    <NewFBESubmittedLastName>Y</NewFBESubmittedLastName>
    <NewSSN>Y</NewSSN>
    <RPID>C</RPID>
    <SSN>Y</SSN>
  </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ManageFBE</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70008</StatusCode>
    <StatusName>InvalidIssuer</StatusName>
    <StatusDescription>InvalidIssuer</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
PreviousManage Daily LimitNextManage Fee

Last updated