MerchantEmails

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  MerchantEmails
Encapsulates information and settings for automated emails.
Available Fields:
welcomeCode
References: Merchant.Email Code Welcome
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service that is sent when a new account is created.
softDeclineCode
References: Merchant.Email Code Soft Decline
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service that is sent when a soft decline occurs.
softDeclineWaitPeriod
References: Merchant.Soft Decline Wait Period Email
XML Representation: attribute
Attributes:
Default Value
Wait period (in days) before soft decline email is sent out.
softDeclineIsBalanceRequired
References: Merchant.Is Required Balance Soft Decline Email
XML Representation: attribute
Attributes:
Default Value
Indicates whether an account has to have outstanding balance for soft decline email to come out.
hardDeclineCode
References: Merchant.Email Code Hard Decline
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service that is sent when a hard decline occurs.
chargebackCode
References: Merchant.Email Code Chargeback
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service that is sent when a chargeback occurs.
statementCode
References: Merchant.Email Code Statement
XML Representation: attribute
Attributes:
Default Value
Code of a letter template set up with a mailing service for a statement of the account.
agentPaymentCode
References: Merchant.Email Code Agent Payment
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when a payment is made through an agent portal.
draftPaymentCode
References: Merchant.Email Code Draft Payment
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when a payment is collected by an agent through self-service portal as part of electronic draft.
portalPaymentCode
References: Merchant.Email Code Portal Payment
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when a payment is made through a self-service portal.
voidCode
References: Merchant.Email Code Void
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when void is done.
refundCode
References: Merchant.Email Code Refund
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when refund occurs.
invoiceCode
References: Merchant.Email Code Invoice
XML Representation: attribute
Attributes:
Default Value
Code of email template, sent out when an invoice is created.
creditCode
References: Merchant.Email Code Credit
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when a credit is issued.
cancelCreditCode
References: Merchant.Email Code Cancel Credit
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when a previously issued credit is reversed.
cancelRefundCode
References: Merchant.Email Code Cancel Refund
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when refund has been cancelled.
invoiceNotificationCode
References: Merchant.Email Code Invoice Notification
XML Representation: attribute
Attributes:
Default Value
Code of an email template, set up with a mailing service for invoice notification email.
invoiceNotificationPeriod
References: Merchant.Email Invoice Notification Period
XML Representation: attribute
Attributes:
Default Value
Number of days after which invoice is created and notification email is sent.
invoiceNotificationIsEnabled
References: Merchant.Is Email Invoice Notification Invoice Only
XML Representation: attribute
Attributes:
Default Value
Indicates whether the email invoice notification includes invoice notification only.
lateFeeCode
References: Merchant.Email Code Late Fee
XML Representation: attribute
Attributes:
Default Value
Code of an email template, sent out when late fee gets applied.
notification1Code
References: Merchant.Notification Email Code1
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the first notification email sent to the customer in case the customer's account became delinquent.
notification2Code
References: Merchant.Notification Email Code2
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the second notification email sent to the customer in case the customer's account became delinquent.
notification3Code
References: Merchant.Notification Email Code3
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the third notification email sent to the customer in case the customer's account became delinquent.
notification1Age
References: Merchant.Notification Email Age1
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age1 is linked to notification email code1).
notification2Age
References: Merchant.Notification Email Age2
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age2 is linked to notification email code2).
notification3Age
References: Merchant.Notification Email Age3
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the customer's account became delinquent, after which a corresponding email is sent to the customer (e.g. Notification email age3 is linked to notification email code3).
collections1Code
References: Merchant.Collections Email Code1
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the first email sent to the customer from 3rd party collections.
collections2Code
References: Merchant.Collections Email Code2
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the second email sent to the customer from 3rd party collections.
collections3Code
References: Merchant.Collections Email Code3
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the third email sent to the customer from 3rd party collections.
collections4Code
References: Merchant.Collections Email Code4
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the fourth email sent to the customer from 3rd party collections.
collections5Code
References: Merchant.Collections Email Code5
XML Representation: attribute
Attributes:
Default Value
Code of an email template set up with a mailing service for the fifth email sent to the customer from 3rd party collections.
collections1Age
References: Merchant.Collections Email Age1
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age1 is linked to Collections email code1).
collections2Age
References: Merchant.Collections Email Age2
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age2 is linked to Collections email code2).
collections4Age
References: Merchant.Collections Email Age4
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age4 is linked to Collections email code4).
collections5Age
References: Merchant.Collections Email Age5
XML Representation: attribute
Attributes:
Default Value
Number of days from the date when the account was sent to collections, after which a corresponding collection email is sent to the customer (e.g. Collections email age5 is linked to Collections email code5).
emailCodeAccountExpiration
References: Merchant.Email Code Account Expiration
XML Representation: attribute
Attributes:
Default Value
Expiration date of email code account.
emailCodeAccountExpirationPeriod
References: Merchant.Email Code Account Expiration Period
XML Representation: attribute
Attributes:
Default Value
Expiration period of the email account code.

XML Sample:

<emails
    welcomeCode="Hello" 
    softDeclineCode="SoftDecline" 
    softDeclineWaitPeriod="2" 
    softDeclineIsBalanceRequired="true" 
    hardDeclineCode="HardDecline" 
    chargebackCode="Chargeback" 
    statementCode="Statement" 
    agentPaymentCode="Agent Payment" 
    draftPaymentCode="draftPaymentCode" 
    portalPaymentCode="portalPaymentCode" 
    voidCode="voidCode" 
    refundCode="refundCode" 
    invoiceCode="invoiceCode" 
    creditCode="creditCode" 
    cancelCreditCode="cancelCreditCode" 
    cancelRefundCode="cancelRefundCode" 
    invoiceNotificationCode="invoiceNotificationCode" 
    invoiceNotificationPeriod="5" 
    invoiceNotificationIsEnabled="true" 
    lateFeeCode="lateFeeCode" 
    notification1Code="notification1Code" 
    notification2Code="notification2Code" 
    notification3Code="notification3Code" 
    notification1Age="1" 
    notification2Age="2" 
    notification3Age="3" 
    collections1Code="collections1Code" 
    collections2Code="collections2Code" 
    collections3Code="collections3Code" 
    collections4Code="collections4Code" 
    collections5Code="collections5Code" 
    collections1Age="1" 
    collections2Age="2" 
    collections4Age="4" 
    collections5Age="5" />
"<emails welcomeCode=\"Hello\" softDeclineCode=\"SoftDecline\" softDeclineWaitPeriod=\"2\" softDeclineIsBalanceRequired=\"true\" hardDeclineCode=\"HardDecline\" chargebackCode=\"Chargeback\" statementCode=\"Statement\" agentPaymentCode=\"Agent Payment\" draftPaymentCode=\"draftPaymentCode\" portalPaymentCode=\"portalPaymentCode\" voidCode=\"voidCode\" refundCode=\"refundCode\" invoiceCode=\"invoiceCode\" creditCode=\"creditCode\" cancelCreditCode=\"cancelCreditCode\" cancelRefundCode=\"cancelRefundCode\" invoiceNotificationCode=\"invoiceNotificationCode\" invoiceNotificationPeriod=\"5\" invoiceNotificationIsEnabled=\"true\" lateFeeCode=\"lateFeeCode\" notification1Code=\"notification1Code\" notification2Code=\"notification2Code\" notification3Code=\"notification3Code\" notification1Age=\"1\" notification2Age=\"2\" notification3Age=\"3\" collections1Code=\"collections1Code\" collections2Code=\"collections2Code\" collections3Code=\"collections3Code\" collections4Code=\"collections4Code\" collections5Code=\"collections5Code\" collections1Age=\"1\" collections2Age=\"2\" collections4Age=\"4\" collections5Age=\"5\" />"

JSON Sample:

{
  "welcomeCode": "Hello",
  "softDeclineCode": "SoftDecline",
  "softDeclineWaitPeriod": "2",
  "softDeclineIsBalanceRequired": true,
  "hardDeclineCode": "HardDecline",
  "chargebackCode": "Chargeback",
  "statementCode": "Statement",
  "agentPaymentCode": "Agent Payment",
  "draftPaymentCode": "draftPaymentCode",
  "portalPaymentCode": "portalPaymentCode",
  "voidCode": "voidCode",
  "refundCode": "refundCode",
  "invoiceCode": "invoiceCode",
  "creditCode": "creditCode",
  "cancelCreditCode": "cancelCreditCode",
  "cancelRefundCode": "cancelRefundCode",
  "invoiceNotificationCode": "invoiceNotificationCode",
  "invoiceNotificationPeriod": "5",
  "invoiceNotificationIsEnabled": true,
  "lateFeeCode": "lateFeeCode",
  "notification1Code": "notification1Code",
  "notification2Code": "notification2Code",
  "notification3Code": "notification3Code",
  "notification1Age": "1",
  "notification2Age": "2",
  "notification3Age": "3",
  "collections1Code": "collections1Code",
  "collections2Code": "collections2Code",
  "collections3Code": "collections3Code",
  "collections4Code": "collections4Code",
  "collections5Code": "collections5Code",
  "collections1Age": "1",
  "collections2Age": "2",
  "collections4Age": "4",
  "collections5Age": "5"
}

XURL Sample:

?welcomeCode=Hello&softDeclineCode=SoftDecline&softDeclineWaitPeriod=2&softDeclineIsBalanceRequired=true&hardDeclineCode=HardDecline&chargebackCode=Chargeback&statementCode=Statement&agentPaymentCode=Agent+Payment&draftPaymentCode=draftPaymentCode&portalPaymentCode=portalPaymentCode&voidCode=voidCode&refundCode=refundCode&invoiceCode=invoiceCode&creditCode=creditCode&cancelCreditCode=cancelCreditCode&cancelRefundCode=cancelRefundCode&invoiceNotificationCode=invoiceNotificationCode&invoiceNotificationPeriod=5&invoiceNotificationIsEnabled=true&lateFeeCode=lateFeeCode&notification1Code=notification1Code&notification2Code=notification2Code&notification3Code=notification3Code&notification1Age=1&notification2Age=2&notification3Age=3&collections1Code=collections1Code&collections2Code=collections2Code&collections3Code=collections3Code&collections4Code=collections4Code&collections5Code=collections5Code&collections1Age=1&collections2Age=2&collections4Age=4&collections5Age=5&
welcomeCode=Hello
softDeclineCode=SoftDecline
softDeclineWaitPeriod=2
softDeclineIsBalanceRequired=true
hardDeclineCode=HardDecline
chargebackCode=Chargeback
statementCode=Statement
agentPaymentCode=Agent Payment
draftPaymentCode=draftPaymentCode
portalPaymentCode=portalPaymentCode
voidCode=voidCode
refundCode=refundCode
invoiceCode=invoiceCode
creditCode=creditCode
cancelCreditCode=cancelCreditCode
cancelRefundCode=cancelRefundCode
invoiceNotificationCode=invoiceNotificationCode
invoiceNotificationPeriod=5
invoiceNotificationIsEnabled=true
lateFeeCode=lateFeeCode
notification1Code=notification1Code
notification2Code=notification2Code
notification3Code=notification3Code
notification1Age=1
notification2Age=2
notification3Age=3
collections1Code=collections1Code
collections2Code=collections2Code
collections3Code=collections3Code
collections4Code=collections4Code
collections5Code=collections5Code
collections1Age=1
collections2Age=2
collections4Age=4
collections5Age=5
Copyright © Constellation Payments. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.