Portfolio

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  Portfolio
Represents portfolio object without sub-components.
Available Fields:
id
References: Portfolio.Code
XML Representation: attribute
Attributes: Unique, CreateOnly, ReadOnly
Default Value
Identifier of the portfolio's owner within the system.
Auto-incremented integer value.
code
References: Portfolio.Ref Code
XML Representation: attribute
Attributes:
Default Value
Pattern: CODE
name
References: Portfolio.Name
XML Representation: attribute
Attributes: Required
Default Value
Pattern: NAME_BUSINESS
Name of the portfolio.
createDate
References: Portfolio.Create Date
XML Representation: attribute
Attributes: CreateOnly, ReadOnly
Default Value
Date when the portfolio was created.
isActive
References: Portfolio.Is Active
XML Representation: attribute
Attributes:
Default Value true
Indicates whether the portfolio is active within the system.
dataExportPolicy
References: Portfolio.Data Export Policy
XML Representation: attribute
Attributes:
Default Value
Pattern: CUSTOM_DATA_EXPORT_POLICY
Regulates whether a merchant uses Data Export mechanism for reports. Two reports are available for data export: Transaction Export Summary and Deposit Export. Default value is "----------".
There are three available values:
1. E - export;
2. N - export and notify;
3. "-" - do not export.
For example, field format "-E----------" indicated that only Deposit Export report is exported.
annualFeePolicy
References: Portfolio.Annual Fee Policy
XML Representation: attribute
Attributes:
Indicates month of a year, when merchant is charged its annual fee.
facilitatorPrefix
References: Portfolio.Facilitator Prefix
XML Representation: attribute
Attributes:
Default Value
Prefix associated with a particular processor that is added to merchant descriptor which is used during the onboarding process. Assigned by a processor.
isMultipleReturnsFileSupported
References: Portfolio.Is Multiple Returns File Supported
XML Representation: attribute
Attributes:
Default Value
Indicates, whether processing of multiple return files within one day is supported or not.
tagList
References: Portfolio.Tag List
XML Representation: attribute
Attributes:
Default Value
Pattern: TEXT
List of tags, used to control system and processing settings at the portfolio level.
cloudCode
References: Portfolio.Cloud Code
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHA
Unique identifier of a client at the portfolio level. The code is used to generate environment code for terminals initialization.
street1
References: Portfolio.Street1
XML Representation: attribute
Attributes:
Default Value
Pattern: STREET
Street address (line 1) of the company the portfolio belongs to.
street2
References: Portfolio.Street2
XML Representation: attribute
Attributes:
Default Value
Pattern: STREET
Street address (line 2) of the company the portfolio belongs to.
city
References: Portfolio.City
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHANUMERIC_EXTENDED
City of the company the portfolio belongs to.
state
References: Portfolio.State
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHANUMERIC_EXTENDED
State of the company the portfolio belongs to.
zipCode
References: Portfolio.ZIP Code
XML Representation: attribute
Attributes:
Default Value
ZIP code/postal code of the company the portfolio belongs to.
countryCode
References: Portfolio.Country Code
XML Representation: attribute
Attributes:
Default Value
Pattern: ALPHA
Country code of the company the portfolio belongs to.
merchantStatementNotificationCode
References: Portfolio.Merchant Statement Notification Code
XML Representation: attribute
Attributes:
Default Value
The code of the notification template to be used to notify about new merchant statements.

XML Sample:

<portfolios>
     <portfolio name="Sample Portfolio"  isActive="true"  dataExportPolicy="----------"  annualFeePolicy="JFMAYJLGSOND" />
</portfolios>
"<portfolios> <portfolio name=\"Sample Portfolio\" isActive=\"true\" dataExportPolicy=\"----------\" annualFeePolicy=\"JFMAYJLGSOND\" /></portfolios>"

JSON Sample:

{
  "name": "Sample Portfolio",
  "isActive": true,
  "dataExportPolicy": "----------",
  "annualFeePolicy": "JFMAYJLGSOND"
}

XURL Sample:

?name=Sample+Portfolio&isActive=true&dataExportPolicy=----------&annualFeePolicy=JFMAYJLGSOND&
name=Sample Portfolio
isActive=true
dataExportPolicy=----------
annualFeePolicy=JFMAYJLGSOND
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.