MerchantLetters

Type: Struct

Abstract: no

Status: Active

Java Class: MerchantLetters

Encapsulates information and settings for automated letters.

Available Fields:

chargebackCode
chargebackIsStatement
collections1Age
collections1Code
collections2Age
collections2Code
collections3Age
collections3Code
collections4Age

collections4Code
collections5Age
collections5Code
hardDeclineCode
hardDeclineIsStatement
invoiceCode
invoicePeriod
notification1Age
notification1Code

notification2Age
notification2Code
notification3Age
notification3Code
softDeclineCode
softDeclineIsBalanceRequired
softDeclineIsStatement
softDeclineWaitPeriod
statementCode

welcomeCode

welcomeCode

References: Merchant.Letter Code Welcome

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse that is sent when a new account is created.

softDeclineCode

References: Merchant.Letter Code Soft Decline

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse when a soft decline occurs.

softDeclineIsStatement

References: Merchant.Is Letter Code Soft Decline Statement

XML Representation: attribute

Attributes:

Default Value

Indicates whether soft decline letter is a statement or not (statements contain data tables).

softDeclineWaitPeriod

References: Merchant.Soft Decline Wait Period Letter

XML Representation: attribute

Attributes:

Default Value

Wait period (in days) before soft decline letter is sent out.

softDeclineIsBalanceRequired

References: Merchant.Is Required Balance Soft Decline Letter

XML Representation: attribute

Attributes:

Default Value

Indicates whether an account has to have outstanding balance for soft decline letter to come out.

hardDeclineCode

References: Merchant.Letter Code Hard Decline

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse when a hard decline occurs.

hardDeclineIsStatement

References: Merchant.Is Letter Code Hard Decline Statement

XML Representation: attribute

Attributes:

Default Value

Indicates whether hard decline letter is a statement or not (statements contain data tables).

chargebackCode

References: Merchant.Letter Code Chargeback

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse when a chargeback occurs.

chargebackIsStatement

References: Merchant.Is Letter Code Chargeback Statement

XML Representation: attribute

Attributes:

Default Value

Indicates whether chargeback letter is a statement or not (statements contain data tables).

statementCode

References: Merchant.Letter Code Statement

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for a statement of the account.

collections1Code

References: Merchant.Collections Letter Code1

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the first letter sent to the customer from 3rd party collections.

collections2Code

References: Merchant.Collections Letter Code2

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the second letter sent to the customer from 3rd party collections.

collections3Code

References: Merchant.Collections Letter Code3

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the third letter sent to the customer from 3rd party collections.

collections4Code

References: Merchant.Collections Letter Code4

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the fourth letter sent to the customer from 3rd party collections.

collections5Code

References: Merchant.Collections Letter Code5

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the fifth letter sent to the customer from 3rd party collections.

collections1Age

References: Merchant.Collections Letter 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 letter is sent to the customer (e.g. Collections letter age1 is linked to Collections letter code1).

collections2Age

References: Merchant.Collections Letter 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 letter is sent to the customer (e.g. Collections letter age2 is linked to Collections letter code2).

collections3Age

References: Merchant.Collections Letter Age3

XML Representation: attribute

Attributes:

Default Value

Number of days from the date when the account was sent to collections, after which a corresponding collection letter is sent to the customer (e.g. Collections letter age3 is linked to Collections letter code3).

collections4Age

References: Merchant.Collections Letter 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 letter is sent to the customer (e.g. Collections letter age4 is linked to Collections letter code4).

collections5Age

References: Merchant.Collections Letter 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 letter is sent to the customer (e.g. Collections letter age5 is linked to Collections letter code5).

invoiceCode

References: Merchant.Notification Letter Code

XML Representation: attribute

Attributes:

Default Value

Notification Letter Code (Invoice)

invoicePeriod

References: Merchant.Notification Letter Period

XML Representation: attribute

Attributes:

Default Value

Period in days after which a notification letter is sent.

notification1Code

References: Merchant.Notification Letter Code1

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the first notification letter sent to the customer in case the customer's account became delinquent.

notification2Code

References: Merchant.Notification Letter Code2

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the second notification letter sent to the customer in case the customer's account became delinquent.

notification3Code

References: Merchant.Notification Letter Code3

XML Representation: attribute

Attributes:

Default Value

Code of a letter template set up with a printhouse for the third notification letter sent to the customer in case the customer's account became delinquent.

notification1Age

References: Merchant.Notification Letter Age1

XML Representation: attribute

Attributes:

Default Value

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age1 is linked to notification letter code1).

notification2Age

References: Merchant.Notification Letter Age2

XML Representation: attribute

Attributes:

Default Value

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age2 is linked to notification letter code2).

notification3Age

References: Merchant.Notification Letter Age3

XML Representation: attribute

Attributes:

Default Value

Number of days from the date when the customer's account became delinquent, after which a corresponding letter is sent to the customer (e.g. Notification letter age3 is linked to notification letter code3).

XML Sample:

<letters
    welcomeCode="welcomeCode" 
    softDeclineCode="softDeclineCode" 
    softDeclineIsStatement="true" 
    softDeclineWaitPeriod="1" 
    softDeclineIsBalanceRequired="true" 
    hardDeclineCode="hardDeclineCode" 
    hardDeclineIsStatement="true" 
    chargebackCode="chargebackCode" 
    chargebackIsStatement="true" 
    statementCode="statementCode" 
    collections1Code="collections1Code" 
    collections2Code="collections2Code" 
    collections3Code="collections3Code" 
    collections4Code="collections4Code" 
    collections5Code="collections5Code" 
    collections1Age="1" 
    collections2Age="2" 
    collections3Age="3" 
    collections4Age="4" 
    collections5Age="5" 
    invoiceCode="invoiceCode" 
    notification1Code="notification1Code" 
    notification2Code="notification2Code" 
    notification3Code="notification3Code" 
    notification1Age="1" 
    notification2Age="2" 
    notification3Age="3" />

"<letters welcomeCode=\"welcomeCode\" softDeclineCode=\"softDeclineCode\" softDeclineIsStatement=\"true\" softDeclineWaitPeriod=\"1\" softDeclineIsBalanceRequired=\"true\" hardDeclineCode=\"hardDeclineCode\" hardDeclineIsStatement=\"true\" chargebackCode=\"chargebackCode\" chargebackIsStatement=\"true\" statementCode=\"statementCode\" collections1Code=\"collections1Code\" collections2Code=\"collections2Code\" collections3Code=\"collections3Code\" collections4Code=\"collections4Code\" collections5Code=\"collections5Code\" collections1Age=\"1\" collections2Age=\"2\" collections3Age=\"3\" collections4Age=\"4\" collections5Age=\"5\" invoiceCode=\"invoiceCode\" notification1Code=\"notification1Code\" notification2Code=\"notification2Code\" notification3Code=\"notification3Code\" notification1Age=\"1\" notification2Age=\"2\" notification3Age=\"3\" />"

JSON Sample:

{
  "welcomeCode": "welcomeCode",
  "softDeclineCode": "softDeclineCode",
  "softDeclineIsStatement": true,
  "softDeclineWaitPeriod": 1,
  "softDeclineIsBalanceRequired": true,
  "hardDeclineCode": "hardDeclineCode",
  "hardDeclineIsStatement": true,
  "chargebackCode": "chargebackCode",
  "chargebackIsStatement": true,
  "statementCode": "statementCode",
  "collections1Code": "collections1Code",
  "collections2Code": "collections2Code",
  "collections3Code": "collections3Code",
  "collections4Code": "collections4Code",
  "collections5Code": "collections5Code",
  "collections1Age": 1,
  "collections2Age": 2,
  "collections3Age": 3,
  "collections4Age": 4,
  "collections5Age": 5,
  "invoiceCode": "invoiceCode",
  "notification1Code": "notification1Code",
  "notification2Code": "notification2Code",
  "notification3Code": "notification3Code",
  "notification1Age": 1,
  "notification2Age": 2,
  "notification3Age": 3
}

XURL Sample:

?welcomeCode=welcomeCode&softDeclineCode=softDeclineCode&softDeclineIsStatement=true&softDeclineWaitPeriod=1&softDeclineIsBalanceRequired=true&hardDeclineCode=hardDeclineCode&hardDeclineIsStatement=true&chargebackCode=chargebackCode&chargebackIsStatement=true&statementCode=statementCode&collections1Code=collections1Code&collections2Code=collections2Code&collections3Code=collections3Code&collections4Code=collections4Code&collections5Code=collections5Code&collections1Age=1&collections2Age=2&collections3Age=3&collections4Age=4&collections5Age=5&invoiceCode=invoiceCode&notification1Code=notification1Code&notification2Code=notification2Code&notification3Code=notification3Code&notification1Age=1&notification2Age=2&notification3Age=3&

welcomeCode=welcomeCode
softDeclineCode=softDeclineCode
softDeclineIsStatement=true
softDeclineWaitPeriod=1
softDeclineIsBalanceRequired=true
hardDeclineCode=hardDeclineCode
hardDeclineIsStatement=true
chargebackCode=chargebackCode
chargebackIsStatement=true
statementCode=statementCode
collections1Code=collections1Code
collections2Code=collections2Code
collections3Code=collections3Code
collections4Code=collections4Code
collections5Code=collections5Code
collections1Age=1
collections2Age=2
collections3Age=3
collections4Age=4
collections5Age=5
invoiceCode=invoiceCode
notification1Code=notification1Code
notification2Code=notification2Code
notification3Code=notification3Code
notification1Age=1
notification2Age=2
notification3Age=3