The following is a list of methods that is provided by the Card Service.
- CreateCardForDependent – generates a card number for a dependent.
- CreateCardForEmployee – generates a card number for an employee.
- GetCards - used to get a list of cards for a cardholder.
- UpdateCardStatus - used to update information for a given card.
- GetCardholderPin - used to retrieve a cardholder's PIN.
The Card Service makes the following assumptions as well as enforce the following business rules.
- Clients shall conform to the WS-I specifications unless otherwise agreed upon by Alegeus Technologies and the administrator.
- Clients shall format SOAP messages in a Document/Literal format over HTTPS.
- Clients shall have already created a valid user ID and password.
- Clients shall have a valid session ID after being authenticated by the system. The session ID needs to be passed in the proper manner as described in the Account Manager Service Guide.
- If the administrator uses the same user ID and password for all of their clients, the administrator is responsible for managing the security of the data.
- Clients should validate data before submitting a request to this Service. This facilitates better performance and accurate processing on both systems.
- Clients shall not attempt to use this service for batch processing of large amounts of data. The service is designed for synchronous calls that send or retrieve small chunks of data. If batch processing is required, then the EDI process should be used.
- If any method fails, the service returns a SOAP fault describing the problem.
__________________________________________________
CreateCardForDependent
This method is used to generate a card number for a dependent. Alegeus Technologies WealthCare Administration System requires a unique card number for each employee and each dependent (for employers offering the card). Cards are issued on a daily basis (including weekends) at 8:00 a.m. CT. The cards are physically distributed approximately two business days after the card order is received. A card number must be created to allow transactions (including deposits) to be put into an employee account (for employers offering the card).
History
The CreateCardForDependent methods are listed below:
- CreateCardForDependentRequest_2013_02
- CreateCardForDependentRequest_2011_10
- CreateCardForDependentRequest_2006_12
- CreateCardForDependentRequest_2006_05
- CreateCardForDependentRequest
- CreateCardForDependentResponse
The CreateCardForDependent method requires the following request and response messages (input and output data). The table below includes the following request messages:
- CreateCardForDependentRequest_2006_12
- CreateCardForDependentRequest_2006_05
- CreateCardForDependentRequest
- CardEffective DateDateIndicates card effective date. If not supplied, it defaults to today’s date. May not be earlier than the current date.
First Available Version: CreateCardForDependentRequest Default Values: Today’s date
- DependentId Stringconditionally requiredRequired if this field is being used as the unique dependent identifier. Either this field or Dependent SSN may be used for this purpose.
First Available Version: CreateCardForDependentRequest - EmployeeIdStringconditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or Employee SSN may be used for this purpose. Required if Dependent ID is not unique within an employer.
First Available Version: CreateCardForDependentRequest - DependentSocialSecurityNumberStringconditionally requiredDependent's social security number.
First Available Version: CreateCardForDependentRequest - EmployeeSocialSecurityNumberStringconditionally requiredEmployee's social security number.
First Available Version: CreateCardForDependentRequest - EmployerIdStringrequiredUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: CreateCardForDependentRequest - ExpireDateDateCard expiration date.
First Available Version: CreateCardForDependentRequest - IssueCardEnumerationrequiredNone = -1
DoNotIssue = 1
Issue = 2
Sent = 3
Conditional = 4
Mailed = 5
Waiting = 6
If Conditional, a new card is to be created and issued only if the employee is not currently in possession of a card in any status.First Available Version: CreateCardForDependentRequest - IssueDateDateIgnored unless IssueCard is set to Issue. Can be set to future date. Indicates when a card will be sent to card vendor.
First Available Version: CreateCardForDependentRequest - ShippingAddressCodeEnumerationNone = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8
If not supplied, defaults to Cardholder if IssueCard is either Issue or Conditional, otherwise not set.
Note: Cannot use PrimaryCardholder for the ShippingAddressCode of an employee. Exception 20064 would be raised.First Available Version: CreateCardForDependentRequest Default Values: Cardholder
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: CreateCardForDependentRequest - ShippingExpediteCodeEnumerationShipping Expedite Code:
None = 0
Standard = 1
OverNight = 2
BulkOverNight = 3First Available Version: CreateCardForDependentRequest_2006_05 - AlternateAddressNameStringThis specifies an alternate address for administrator or employer, depending upon TPAAlternate or EmployerAlternate specified in shipping address code field. If no value is specified, the default value setup in system is used. If the value specified doesn’t exist in the system, an exception is thrown.
First Available Version: CreateCardForDependentRequest_2006_12 - PinIssueAddressCodeEnumerationconditionally requiredThe address the PIN Mailer is sent to.
Required if IssuePINMailer = True.
None = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8First Available Version: CreateCardForDependentRequest_2013_02 Default Values: None
- IssuePinMailerBooleanSpecifies whether or not to issue a PIN Mailer associated with the request debit card.
False – Does not issue a PIN Mailer
True – Issues a PIN MailerFirst Available Version: CreateCardForDependentRequest_2013_02 Default Values: FALSE
Response Message: Empty Message
Example of a CreateCardForDependent SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>c4lzhd55eu1eny55qxw0fp45</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<CreateCardForDependent_2006_12 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Request/2006/12/">
<CreateCardForDependentRequest_2006_12>
<CardEffectiveDate>2004-09-14</CardEffectiveDate>
<DependentSocialSecurityNumber>122132876</DependentSocialSecurityNumber>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerId>EASE10</EmployerId>
<IssueCard xmlns="http://www.medibank.com/MBIWebServices/Enums/">Issue</IssueCard>
<IssueDate>2004-09-14</IssueDate>
<ShippingAddressCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">EmployerAlternate</ShippingAddressCode>
<TpaId>T00209</TpaId>
<ShippingExpediteCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Standard</ShippingExpediteCode>
<AlternateAddressName> Test Address</AlternateAddressName>
</CreateCardForDependentRequest_2006_12>
</CreateCardForDependent_2006_12>
</soap:Body>
</soap:Envelope>
Example of CreateCardForDependent SOAP response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<CreateCardForDependentResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Response/2004/06/">
<CreateCardForDependentResult />
</CreateCardForDependentResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following
is an example of the client code (using a .NET proxy class for accessing the
service) used when adding an employee using the CreateCardForDependent web
method.
try
{
// Create the session SOAP header in order to pass the Card Service
// the client’s current session id.
mbiSessionHeader = new CardServiceNameSpace.MBISessionHeader();
// Create proxy object for card service
proxy = new CardServiceNameSpace.CardService();
// Create request message for method call (input parameters)
request = new CardServiceNameSpace.CreateCardForDependentRequest_2006_12();
// Set the input parameters
request.CardEffectiveDate = Convert.ToDateTime(_cardEffectiveDate.Text);
request.DependentSocialSecurityNumber = _dependentSocialSecurityNumber.Text;
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerId = _employerId.Text;
if(_expireDate.Text.Length > 0)
{
request.ExpireDate = Convert.ToDateTime(_expireDate.Text);
}
request.IssueCard = (CardServiceNameSpace.CardIssueCodes)_issueCard.SelectedItem;
if(_issueDate.Text.Length > 0)
{
request.IssueDate = Convert.ToDateTime(_issueDate.Text);
}
request.ShippingAddressCode =
(CardServiceNameSpace.CardholderIssueAddress)
_shippingAddressCode.SelectedItem;
request.TpaId = _tpaId.Text;
request.AlternateAddressName =_alternateAddress.Text;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.CreateCardForDependent(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
__________________________________________________
CreateCardForEmployee
This method is used to generate a card number for an employee. WCA requires a unique card number for each employee and each dependent (for employers offering the card). Cards are issued on a daily basis (including weekends) at 8:00 a.m. CT. The cards are physically distributed approximately two business days after the card order is received. A card number must be created to allow transactions (including deposits) to be put into an employee account (for employers offering the card).
History
The CreateCardForEmployee methods are listed below:
- CreateCardForEmployeeRequest_2013_02
- CreateCardForEmployeeRequest_2006_12
- CreateCardForEmployeeRequest_2006_05
- CreateCardForEmployeeRequest
- CreateCardForEmployeeResponse
The CreateCardForEmployee method requires the following request and response messages (input and output data). The table below includes the following request messages:
- CreateCardForEmployeeRequest_2006_12
- CreateCardForEmployeeRequest_2006_05
- CreateCardForEmployeeRequest
- CardEffectiveDateDateIndicates card effective date. If not supplied it, defaults to today’s date. May not be earlier than the current date.
First Available Version: CreateCardForEmployeeRequest Default Values: Today’s date
- EmployeeSocialSecurityNumberStringconditionally requiredEmployee’s social security number.
First Available Version: CreateCardForEmployeeRequest - EmployeeId Stringconditionally requiredRequired if this field is being used as the unique employee identifier. Either this field or SSN may be used for this purpose.
First Available Version: CreateCardForEmployeeRequest - EmployerIdStringrequiredUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: CreateCardForEmployeeRequest - ExpireDateDateCard expiration date.
First Available Version: CreateCardForEmployeeRequest - IssueCardEnumerationrequiredNone = -1
DoNotIssue = 1
Issue = 2
Sent = 3
Conditional = 4
Mailed = 5
Waiting = 6
If Conditional, a new card is to be created and issued only if the employee is not currently in possession of a card in any status.First Available Version: CreateCardForEmployeeRequest - IssueDateDateIgnored unless IssueCard is set to Issue. Can be set to future date. Indicates when a card will be sent to card vendor.
First Available Version: CreateCardForEmployeeRequest - ShippingAddressCodeEnumerationNone = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8
If not supplied, defaults to Cardholder if IssueCard is either Issue or Conditional, otherwise not set.
Note: Cannot use PrimaryCardholder for the ShippingAddressCode of an employee. Exception 20064 would be raised.First Available Version: CreateCardForEmployeeRequest Default Values: Cardholder
- TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: CreateCardForEmployeeRequest - ShippingExpediteCodeEnumerationShipping Expedite Code:
None = 0
Standard = 1
OverNight = 2
BulkOverNight = 3First Available Version: CreateCardForEmployeeRequest_2006_05 - AlternateAddressNameStringThis specifies an alternate address for administrator or employer, depending upon TPAAlternate or EmployerAlternate specified in the shipping address code field. If no value is specified, the default value setup in system is used. If the value specified doesn’t exist in the system an exception is thrown(error number= 20063).
First Available Version: CreateCardForEmployeeRequest_2006_12 - PinIssueAddressCodeEnumerationconditionally requiredThe address the PIN Mailer is sent to.
Required is IssuePINMailer = True.
None = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8First Available Version: CreateCardForEmployeeRequest_2013_02 Default Values: None
- IssuePinMailerBooleanSpecifies whether or not to issue a PIN Mailer associated with the request debit card.
False – Does not issue a PIN Mailer
True – Issues a PIN MailerFirst Available Version: CreateCardForEmployeeRequest_2013_02 Default Values: FALSE
Response Message: Empty Message
Example of a CreateCardForEmployee SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>c4lzhd55eu1eny55qxw0fp45</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<CreateCardForEmployee_2006_12 xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Request/2006/12/">
<CreateCardForEmployeeRequest_2006_12>
<CardEffectiveDate>2004-09-14</CardEffectiveDate>
<EmployeeSocialSecurityNumber>332323232</EmployeeSocialSecurityNumber>
<EmployerId>EASE10</EmployerId>
<IssueCard xmlns="http://www.medibank.com/MBIWebServices/Enums/">Issue</IssueCard>
<IssueDate>2004-09-14</IssueDate>
<ShippingAddressCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">EmployerAlternate</ShippingAddressCode>
<TpaId>T00209</TpaId>
<ShippingExpediteCode xmlns="http://www.medibank.com/MBIWebServices/Enums/">Standard</ShippingExpediteCode>
<AlternateAddressName>Test Address</AlternateAddressName>
</CreateCardForEmployeeRequest_2006_12>
</CreateCardForEmployee_2006_12>
</soap:Body>
</soap:Envelope>
Example of a CreateCardForEmployee SOAP response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<CreateCardForEmployeeResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Response/2004/06/">
<CreateCardForEmployeeResult />
</CreateCardForEmployeeResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following
is an example of the client code (using a .NET proxy class to connect with
the service) used when calling the CreateCardForEmployee method.
try
{
// Create the session SOAP header in order to pass the Card Service
// the client’s current session id.
mbiSessionHeader = new CardServiceNameSpace.MBISessionHeader();
// Create proxy object for the card service
proxy = new CardServiceNameSpace.CardService();
// Create request message for method call (input parameters)
request = new CardServiceNameSpace.CreateCardForEmployeeRequest_2006_12();
// Set the input parameters
request.CardEffectiveDate = Convert.ToDateTime(_cardEffectiveDate.Text);
request.EmployeeSocialSecurityNumber = _employeeSocialSecurityNumber.Text;
request.EmployerId = _employerId.Text;
if(_expireDate.Text.Length > 0)
{
request.ExpireDate = Convert.ToDateTime(_expireDate.Text);
}
request.IssueCard = (CardServiceNameSpace.CardIssueCodes)_issueCard.SelectedItem;
if(_issueDate.Text.Length > 0)
{
request.IssueDate = Convert.ToDateTime(_issueDate.Text);
}
request.ShippingAddressCode =
(CardServiceNameSpace.CardholderIssueAddress)
_shippingAddressCode.SelectedItem;
request.TpaId = _tpaId.Text;
request.AlternateAddressName =_alternateAddress.Text;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.CreateCardForEmployee(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
__________________________________________________
GetCards
This method is used to get a list of cards for a cardholder.
History
The GetCards methods are listed below:
- GetCardsRequest_2011_12
- GetCardsRequest
- GetCardsResponse_2013_02
- GetCardsResponse_2011_12
- GetCardsResponse_2011_10
- GetCardsResponse_2007_12
- GetCardsResponse_2006_12
- GetCardsResponse_2006_05
- GetCardsResponse
The GetCards method requires the following request and response messages (input and output data).
The table below includes the following request messages:
- GetCardsRequest
- CardholderId Stringconditionally requiredReplaced by Employee and Dependent SSN in version 2011_10.
Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or SSN may be used for this purpose.First Available Version: GetCardsRequest - CardholderSocialSecurityNumberStringconditionally requiredReplaced by Employee and Dependent ID in version 2011_10.
Required if this field is being used as the unique cardholder identifier and card number is not provided. Either this field or Cardholder ID may be used for this purpose.First Available Version: GetCardsRequest - CardNumberStringconditionally requiredEither a Card Number or a Card Proxy can be passed in this field. If Card Proxy is used, then the ‘IsProxyCard’ field must be set to ‘True’.
When requesting debit card information, provide one of the following: Card Number,
Employee/Dependent’s Social Security Number, or Employee/Dependent ID.
If multiple fields are provided in addition to the card number, the card number is used.First Available Version: GetCardsRequest - EmployerIdStringrequiredUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: GetCardsRequest - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: GetCardsRequest - VerboseModeBooleanOptional, if set to true, the method may return more details as to why a query did not return any records. For example, if an invalid employee social security number was sent.
First Available Version: GetCardsRequest Default Values: FALSE
- DependentSocialSecurityNumberStringconditionally requiredDependent’s social security number.
First Available Version: GetCardsRequest_2011_10 - DependentIdStringconditionally requiredRequired if this field is being used as the unique dependent identifier. Either this field or SSN may be used for this purpose.
First Available Version: GetCardsRequest_2011_10 - EmployeeSocialSecurityNumberStringconditionally requiredEmployee’s social security number. Required if dependent IDs are not unique within an Employer.
First Available Version: GetCardsRequest_2011_10 - EmployeeIDStringconditionally requiredEmployee’s WCA ID. Required if dependent IDs are not unique within an Employer.
First Available Version: GetCardsRequest_2011_10 - IsProxyCardBooleanFalse (0) or True (1) values accepted.
Note: For security, the Card Proxy number is always returned in the response.First Available Version: GetCardsRequest_2011_12 Default Values: FALSE
- GetCardsResponse_2013_02
- GetCardsResponse_2007_12
- GetCardsResponse_2006_12
- GetCardsResponse_2006_05
- GetCardsResponse
- CardEffectiveDateStringIndicates card effective date. If not supplied it default to today’s date. May not be earlier than the current date.
First Available Version: GetCardsResponse - CardNumberStringCard Proxy Number.
Note: The Card Proxy number is returned in this field when either 0 or 1 is passed in the “IsProxyCard” field in the request. For security, the Card Proxy number is always returned in the response.First Available Version: GetCardsResponse - CardCurrentStatusEnumerationStatus of the card.
New - 1
Active - 2
TempInactive - 3
PermInactive - 4
LostStolen - 5First Available Version: GetCardsResponse - CardholderFirstNameStringCardholder’s first name.
First Available Version: GetCardsResponse - CardholderLastNameStringCardholder’s last name.
First Available Version: GetCardsResponse - CardholderMiddleInitialStringCardholder’s middle initial.
First Available Version: GetCardsResponse - CardholderIdStringCardholder’s ID.
First Available Version: GetCardsResponse - DependentCardBooleanIndicates whether or not this card belongs to a dependent. True indicates that the card belongs to a dependent, false indicates the card belongs to an employee.
First Available Version: GetCardsResponse - EmployerIdStringUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: GetCardsResponse - ExpireDateStringThe card expiration date.
First Available Version: GetCardsResponse - IssueCardCodeEnumerationNone = -1
DoNotIssue = 1
Issue = 2
Sent = 3
Conditional = 4
Mailed = 5
Waiting = 6First Available Version: GetCardsResponse - IssueDateStringDate that the card should be issued.
First Available Version: GetCardsResponse - ShippingAddressCodeEnumerationNone = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8First Available Version: GetCardsResponse - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: GetCardsResponse - LastUpdateDateDateTimeDate of the last update.
First Available Version: GetCardsResponse - StatusChangeReasonEnumerationValid Values for status “New”
InitialCardIssuance= 17
Valid Values for Status “Active”
IVR= 1
None= 3
CardholderCalledtoActivate = 2
Valid Values for Status “TempInactive”
EmployeeTerminated= 4
EligibilityChange= 5
PendingCardholderReimbursement = 6
EmployerTerminated= 7
CardholderRequestedChange= 8
EmployerRequestedChange= 9
None = 3
Valid Values for Status “Lost&Stolen”
CardholderReportedCardStolen = 10
CardholderReportedCardLost= 11
IVRForLostStolen=5
CardNotReceived = 13
EmployerRequestedChangeForLostOrStolen = 14
None = 3
Valid Values for “PermInactive”
None = 3
EmployeeTerminatedForPermInactive = 15
EligibilityChangeForPermInactive = 16First Available Version: GetCardsResponse - ShippingExpediteCodeEnumerationShipping Expedite Codes:
None = 0
Standard = 1
OverNight = 2
BulkOverNight = 3First Available Version: GetCardsResponse_2006_05 - AlternateAddressNameStringThis specifies an alternate address for administrator or employer, depending upon TPAAlternate or EmployerAlternate specified in shipping address code field
First Available Version: GetCardsResponse_2006_12 - CardTypeStringReturns Payment Card or Combo Card data.
First Available Version: GetCardsResponse_2007_12 - PickDateStringThe processed date within the .psi file.
First Available Version: GetCardsResponse_2007_12 - IssueByStringThe user ID that created the card.
First Available Version: GetCardsResponse_2007_12 - ShippingAddressStringThe street address for the ShippingAddressCode field that is displayed on the Card screen.
First Available Version: GetCardsResponse_2007_12 - MailedDateStringDate the card was mailed.
First Available Version: GetCardsResponse_2007_12 - ActivationDateStringThe date of which the card status changed from New to Active.
First Available Version: GetCardsResponse_2007_12 - ThermalLogoIdStringIf it was used on the card, the Thermal Logo (Front) Description is returned.
First Available Version: GetCardsResponse_2007_12 - PINMailerRequestDateStringThe date the PIN Mailer was requested.
First Available Version: GetCardsResponse_2013_02 - PINMailerDateStringThe date the PIN Mailer was mailed to the recipient.
First Available Version: GetCardsResponse_2013_02 - PINMailerAddressStringThe address the PIN Mailer was shipped to.
First Available Version: GetCardsResponse_2013_02 - PINMailerIssuedBooleanTrue – A PIN Mailer was issued. False – A PIN Mailer was not issued.
First Available Version: GetCardsResponse_2013_02 - CardProxyNumberStringThe debit card’s Card Proxy number. This value is required for retrieving a debit card’s PIN value.
First Available Version: GetCardsResponse_2013_02 - NotesStringNotes for card
First Available Version: GetCardsResponse_2015_06
Example of a GetCards SOAP request message
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1/ICardService/GetCards</Action>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">b3xjotpxc2d1jtbkgh1xfbwa</MBISessionID>
</mbiSessionHeader>
</s:Header>
<s:Body>
<GetCards xmlns="http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1">
<request xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Card/Request/2011/10/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:d4p3="http://bensoft.metavante.com/WebServices/Messages/Card/Request/2013/02/" i:type="d4p3:GetCards_2013_02">
<d4p1:CardNumber>5543240032725793</d4p1:CardNumber>
<d4p1:DependentId i:nil="true" />
<d4p1:DependentSocialSecurityNumber i:nil="true" />
<d4p1:EmployeeId i:nil="true" />
<d4p1:EmployeeSocialSecurityNumber i:nil="true" />
<d4p1:EmployerId>LOPDEMO123</d4p1:EmployerId>
<d4p1:TpaId i:nil="true" />
<d4p1:VerboseMode>false</d4p1:VerboseMode>
<IsProxyCard xmlns="http://bensoft.metavante.com/WebServices/Messages/Card/Request/2011/12/">false</IsProxyCard>
</request>
</GetCards>
</s:Body>
</s:Envelope>
Example of a GetCards SOAP response message
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
<MessageId>urn:uuid:f0293d39-be97-40a6-9fb2-9694fc08245e</MessageId>
</MBIMessageIdHeader>
</s:Header>
<s:Body>
<GetCardsResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1">
<GetCardsResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Card/Response/2011/10/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:GetCardsResponse i:type="b:GetCardsResponse_2013_02" xmlns:b="http://bensoft.metavante.com/WebServices/Messages/Card/Response/2013/02/">
<a:ActivationDate>-1</a:ActivationDate>
<a:AlternateAddressName i:nil="true" />
<a:CardCurrentStatus>New</a:CardCurrentStatus>
<a:CardEffectiveDate>20130130</a:CardEffectiveDate>
<a:CardNumber>5543240032725793</a:CardNumber>
<a:CardType>Payment Card</a:CardType>
<a:CardholderFirstName>Jan</a:CardholderFirstName>
<a:CardholderId>jones321D1</a:CardholderId>
<a:CardholderLastName>Jones</a:CardholderLastName>
<a:CardholderMiddleInitial />
<a:DependentCard>true</a:DependentCard>
<a:EmployerId>LOPDEMO123</a:EmployerId>
<a:ExpireDate>20160131</a:ExpireDate>
<a:IssueBy>Admin, , Tony TPA</a:IssueBy>
<a:IssueCardCode>Issue</a:IssueCardCode>
<a:IssueDate>20130130</a:IssueDate>
<a:LastUpdateDate>2013-01-30T10:23:26.903</a:LastUpdateDate>
<a:MailedDate />
<a:PickDate>0</a:PickDate>
<a:ShippingAddress>123 Main St, , Waltham, MA, 01234, </a:ShippingAddress>
<a:ShippingAddressCode>Cardholder</a:ShippingAddressCode>
<a:ShippingExpediteCode>Standard</a:ShippingExpediteCode>
<a:StatusChangeReason>InitialCardIssuance</a:StatusChangeReason>
<a:ThermalLogoId />
<a:TpaId>T01213</a:TpaId>
<b:PinMailedDate />
<b:PinMailerAddress>123 Main St, , Waltham, MA, 01234, </b:PinMailerAddress>
<b:PinMailerIssued>false</b:PinMailerIssued>
<b:PinRequestedDate>20130130</b:PinRequestedDate>
</a:GetCardsResponse>
</GetCardsResult>
</GetCardsResponse>
</s:Body>
</s:Envelope>
Example Client Code
The following
is an example of the client code (using a .NET proxy class to connect with
the service) used when calling the GetCards method.
try
{
_dataset.Tables["Cards"].Clear();
// Create the session SOAP header in order to pass the Card Service
// the client’s current session id.
mbiSessionHeader = new CardServiceNameSpace.MBISessionHeader();
// Create proxy object for the Card Service
proxy = new CardServiceNameSpace.CardService();
// Create request message for method call (input parameters)
request = new CardServiceNameSpace.GetCardsRequest();
// Set the input parameters
request.CardholderSocialSecurityNumber = _socialSecurityNumber.Text;
request.CardNumber = _cardNumber.Text;
request.EmployerId = _employerId.Text;
request.TpaId = _tpaId.Text;
request.VerboseMode = Convert.ToBoolean(_verboseMode.Text);
// session ID returned from logon method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
responses = proxy.GetCards(request);
if(responses != null)
{
for(int i=0; i < responses.Length; i++)
{
_dataset.Tables["Cards"].Rows.Add(new string[]
{
responses[i].CardEffectiveDate,
responses[i].CardNumber,
responses[i].CardCurrentStatus.ToString(),
responses[i].CardholderFirstName,
responses[i].CardholderLastName,
responses[i].CardholderMiddleInitial,
responses[i].EmployerId,
responses[i].ExpireDate,
responses[i].IssueCardCode.ToString(),
responses[i].IssueDate,
responses[i].LastUpdateDate.ToString(),
responses[i].ShippingAddressCode.ToString(),
responses[i].TpaId,
responses[i].ShippingExpediteCode.ToString(),
responses[i]. StatusChangeReason.ToString(),
responses[i]. AlternateAddressName,
});
}
}
_accounts.CaptionText = _dataset.Tables["Cards"].Rows.Count + " records found.";
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
__________________________________________________
UpdateCardStatus
This method is used to update information for a given card.
History
The UpdateCardStatus methods are listed below:
- UpdateCardStatusRequest_2011_12
- UpdateCardStatusRequest
- UpdateCardStatusRequest
The UpdateCardStatus method requires the following request and response messages (input and output data). The table below includes the following request messages:
- UpdateCardStatusRequest
- CardNumberStringrequiredEmployee or Dependent card number.
First Available Version: UpdateCardStatusRequest - CardStatusEnumerationrequiredStatus of the card.
New - 1
Active - 2
TempInactive - 3
PermInactive - 4
LostStolen - 5First Available Version: UpdateCardStatusRequest Default Values: New
- EmployerIdStringrequiredUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: UpdateCardStatusRequest - TpaIdStringA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: UpdateCardStatusRequest - StatusChangeReasonEnumerationValid Values for status “New”
InitialCardIssuance= 17
Valid Values for Status “Active”
IVR= 1
None= 3
CardholderCalledtoActivate = 2
Valid Values for Status “TempInactive”
EmployeeTerminated= 4
EligibilityChange= 5
PendingCardholderReimbursement = 6
EmployerTerminated= 7
CardholderRequestedChange= 8 EmployerRequestedChange= 9
None = 3
Valid Values for Status “Lost&Stolen”
CardholderReportedCardStolen = 10
CardholderReportedCardLost= 11
IVRForLostStolen=5
CardNotReceived = 13
EmployerRequestedChangeForLostOrStolen = 14
None = 3
Valid Values for “PermInactive”
None = 3
EmployeeTerminatedForPermInactive = 15
EligibilityChangeForPermInactive = 16First Available Version: UpdateCardStatusRequest Default Values: None
- IsProxyCardBooleanTrue – Card Proxy Number is passed in CardNumber field
False – Card Number is passed in
CardNumber field
The Card Number field in the Response will return card number or proxy card number based on the 'IsProxyCard' value within the Request.First Available Version: UpdateCardStatusRequest_2011_12 Default Values: FALSE
- PinIssueAddressCodeEnumerationconditionally requiredThe address the PIN Mailer is sent to.
Required if IssuePINMailer = True.
None = 0
Cardholder = 1
Employer = 2
Tpa (Administrator) = 3
MBI (Alegeus Technologies) = 4
PrimaryCardholder = 5
CardholderShipping = 6
EmployerAlternate = 7
TPAAlternate = 8First Available Version: UpdateCardStatusRequest_2013_02 Default Values: None
- IssuePinMailerBooleanSpecifies whether or not to issue a PIN Mailer associated with the request debit card. False – Does not issue a PIN Mailer True – Issues a PIN Mailer
First Available Version: UpdateCardStatusRequest_2013_02 Default Values: FALSE
- NotesStringNotes for card status update.
First Available Version: UpdateCardStatusRequest_2015_06
Response Message: Empty Message
Example of a UpdateCardStatus SOAP request message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBISessionHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/">
<MBISessionID>c4lzhd55eu1eny55qxw0fp45</MBISessionID>
</MBISessionHeader>
</soap:Header>
<soap:Body>
<UpdateCardStatus xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Request/2004/06/">
<updateCardStatusRequest>
<CardNumber>5543240022120955</CardNumber>
<CardStatus xmlns="http://www.medibank.com/MBIWebServices/Enums/">Active</CardStatus>
<EmployerId>EASE10</EmployerId>
<TpaId>T00209</TpaId>
</updateCardStatusRequest>
</UpdateCardStatus>
</soap:Body>
</soap:Envelope>
Example of a UpdateCardStatus SOAP response message
<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<MBIMessageIdHeader xmlns="http://www.medibank.com/MBIWebServices/SoapHeader/" />
</soap:Header>
<soap:Body>
<UpdateCardStatusResponse xmlns="http://www.medibank.com/MBIWebServices/Employee/Messages/Card/Response/2004/06/">
<UpdateCardStatusResult />
</UpdateCardStatusResponse>
</soap:Body>
</soap:Envelope>
Example Client Code
The following
is an example of the client code (using a .NET proxy class to connect to the
service) used when calling the UpdateCardStatus method.
try
{
// Create the session SOAP header in order to pass the Card Service
// the client’s current session id.
mbiSessionHeader = new CardServiceNameSpace.MBISessionHeader();
// Create proxy object for the Card Service
proxy = new CardServiceNameSpace.CardService();
// Create request message for method call (input parameters)
request = new CardServiceNameSpace.UpdateCardStatusRequest();
// Set the input parameters
request.CardNumber = _cardNumber.Text;
request.CardStatus = (CardServiceNameSpace.CardStatusUpdate) _cardStatus.SelectedItem;
request.CardStatusSpecified = true;
request.EmployerId = _employerId.Text;
request.TpaId = _tpaId.Text;
// session ID returned from login method
mbiSessionHeader.MBISessionID = _sessionId.Text;
proxy.MBISessionHeaderValue = mbiSessionHeader;
// Call the method
response = proxy.UpdateCardStatus(request);
MessageBox.Show("Finished.");
}
catch(SoapException se)
{
// perform needed operations
}
catch(Exception ex)
{
// perform needed operations
}
Rules for Changing Card Status
1 If there are not any cards currently active for the employee or dependent.
__________________________________________________
GetCardholderPIN
This method is used to retrieve a participant’s PIN number by customers with external web portal. Only Cards in a New, Active and TI status will return a PIN number. Requests will fail if the debit card’s status is Lost\Stolen or PI. Request will also fail if with invalid parameters are passed. The profile setting “Get Cardholder Pin” must be enabled for the web service user, in order for that user to be able to request a PIN number.
Clients wish to retrieve PINs via this web services request, must be able to provide the debit card’s Card Proxy. Each debit card is assigned a Card Proxy Number automatically. Card Proxy Numbers can be retrieved using the GetCards web services request or an EM EDI Card Export record.
History
The GetCardholderPIN methods are listed below:
- GetCardholderPINRequest
Response Messages
-
GetCardholderPINResponse
The GetCardholderPIN method requires the following request and response messages (input and output data). The table below includes the following request messages:
- GetCardHolderPINRequest
- TpaIdStringrequiredA unique identifer for your administrator instance, generated by WCA when the instance was first set up. If a value is not sent, the TPA ID from the user making the request with be used.
First Available Version: GetCardholderPINRequest - EmployerIdStringrequiredUnique identifier for the employer. Note: When the employer was created, WealthCare Admin assigned the 3-character prefix; you assigned the remaining characters.
First Available Version: GetCardholderPINRequest - CardProxyNumberStringrequiredThe card proxy number for a specific debit card. Can be retrieved by calling the GetCards request.
First Available Version: GetCardholderPINRequest - VerboseModeBooleanOptional, if set to true, the method may return more details as to why a query did not return any records.
First Available Version: GetCardholderPINRequest Default Values: FALSE
- GetCardholderPINResponse
- CardProxyNumber StringThe card proxy number for a specific debit card.
First Available Version: GetCardholderPINResponse - PIN StringThe card’s PIN number.
First Available Version: GetCardholderPINResponse
Example of a GetCardholderPIN SOAP request message
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<Action s:mustUnderstand="1" xmlns="http://schemas.microsoft.com/ws/2005/05/addressing/none">http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1/ICardService/GetCardholderPin</Action>
<mbiSessionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBISessionID xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers">ph21tpk87864ocbd2wpxptx</MBISessionID>
</mbiSessionHeader>
</s:Header>
<s:Body>
<GetCardholderPin xmlns="http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1">
<request xmlns:d4p1="http://bensoft.metavante.com/WebServices/Messages/Card/Request/2013/02/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<d4p1:CardProxyNumber>1100005802468783</d4p1:CardProxyNumber>
<d4p1:EmployerId>PINDEMO123</d4p1:EmployerId>
<d4p1:TpaId>T01234</d4p1:TpaId>
<d4p1:VerboseMode>false</d4p1:VerboseMode>
</request>
</GetCardholderPin>
Example of a GetCardholderPIN SOAP response message
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<MBIMessageIdHeader xmlns="http://bensoft.metavante.com/WebServices/SoapHeader/">
<MessageId>urn:uuid:4671203d-cc6f-45b0-8c23-6b3d4e51bc91</MessageId>
</MBIMessageIdHeader>
<mbiWarningsHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<MBIWarnings i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/MBI.WebServices.Wcf.Headers" />
</mbiWarningsHeader>
</s:Header>
<s:Body>
<GetCardholderPinResponse xmlns="http://bensoft.metavante.com/WebServices/Contracts/Card/2011/10/V1">
<GetCardholderPinResult xmlns:a="http://bensoft.metavante.com/WebServices/Messages/Card/Response/2013/02/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:CardProxyNumber>1100005802468783</a:CardProxyNumber>
<a:Pin>7032</a:Pin>
</GetCardholderPinResult>
</GetCardholderPinResponse>
</s:Body>
</s:Envelope>