Name
Description
Type
Additional information
templateType

Identifies the process (notification type) triggering/performing the send email call and the Template to use (Example: Structs.EmailTemplateType.Virtual_Activation, Structs.EmailTemplateType.Plastic_Request, etc)

integer

None.

debitCardId

this is the end users card id is utilized primarily for logging puposes the portal calling the service should pass along this detail for tracking

integer

None.

originatingPartnerId

this is the end users Partner Id, utilized to obtain the email templates to be used the portal calling the service should pass along this detail for tracking

integer

None.

originatingClientIp

This is the end users ip that is triggering a call to this service The portal calling the service should obtain the external ip of the client and pass along Optional, as can be called by system itself

string

None.

entityName

Identifies the calling portal/ entity name (Example: CardPortal, etc)

string

Required

String length: inclusive between 3 and 30

emailAddress

Destination to send the email notification to

string

Required

language

This is the primary language for the communication to be used in determination of the template chosen and the text included within it

string

None.

firstName

Used as an addressing string to the user in "to" email address used on demand as adressing string to the user in the body of the mail

string

Required

subject

Value that is used as a subject line in sending the email

string

Required

lastName

Used to address email recipient (in conjunction with first name) Data to include within body of email to identify users last name where applicable Used within body of email as replacement value for ###FullName (in conjunction with FirstName) within email templates

string

None.

accessCode

Used within body of email as replacement value for ###AccCode within email templates

string

None.

date

Used within body of email as replacement value for ###date within email templates

string

None.

currency

Used within body of email as replacement value for ###currency within email templates

string

None.

amount

Used within body of email as replacement value for ###Amount within email templates

string

None.

initialLoadAmount

Used within body of email as replacement value for ###InitialLoadAmount within email templates

string

None.

transactionId

Used within body of email as replacement value for ###TransactionId within email templates

string

None.

transactionDescription

Used within body of email as replacement value for ###TransactionDescription within email templates

string

None.

docType

Used within body of email as replacement value for ###DocType within email templates

string

None.

reason

Used within body of email as replacement value for ###Reason within email templates

string

None.

san

Used within body of email as replacement value for ###SAN within email templates

string

String length: inclusive between 9 and 10

userName

The merchant group’s username. Provided by your account manager.

string

Required

password

The merchant group’s password. Provided by your account manager.

string

Required

serviceIndex

The merchant service index. Provided by your account manager.

string

Required

uniqId

A unique number (integer) with which the service is consumed. (This number is unique, random and cannot be reused) This number is unique by each service consumed

integer

Required

Range: inclusive between 1 and 2147483647

clientId

Partner's assigned Id number. Provided by your account manager.

integer

Required

Range: inclusive between 1 and 2147483647

transactionToken

Provided by your account manager.

string

Required

orginalPartnerId

integer

None.