MerchantRemittanceConfig

Type:  Struct
Abstract:  no
Status:  Active
Java Class:  MerchantRemittanceConfig
Integration settings for the merchant remittance process.
Available Fields:
remittancePeriodAmex
References: Merchant Account Group.Amex Remittance Period
XML Representation: attribute
Attributes:
Default Value
remittancePeriodCards
References: Merchant Account Group.CC Remittance Period
XML Representation: attribute
Attributes:
Default Value
remittancePeriodACH
References: Merchant Account Group.ACH Remittance Period
XML Representation: attribute
Attributes:
Default Value
remittancePeriodDeposit
References: Merchant Account Group.Remittance Period
XML Representation: attribute
Attributes: Required
Default Value
totalBalance
References: Merchant Account Group.Balance
XML Representation: attribute
Attributes: ReadOnly
Default Value
Shows the current balance of a merchant/merchant account. If the value is positive, 3rd party processor owes money to the merchant. If the value is negative, merchant owes money to a 3rd party processor.

Note: This field is read-only and cannot be modified.
netBalance
References: Merchant Account Group.Net Balance
XML Representation: attribute
Attributes: ReadOnly
Default Value
Shows the amount of money owed to the merchant excluding reserves.

Note: This field is read-only and cannot be modified.
maximumWithholdingAmount
References: Merchant Account Group.Max Withholding Amount
XML Representation: attribute
Attributes:
Default Value
Maximum amount of money that can be withheld in favor of reserves within a single remittance.
merchantStatementRecipientList
References: Merchant Account Group.Remittance Recipient List
XML Representation: attribute
Attributes:
Default Value
List of email addresses of people that will receive a PDF copy of remittance statement once it is generated.
merchantStatementRecipientListMonthly
References: Merchant Account Group.Remittance Recipient List Monthly
XML Representation: attribute
Attributes:
Default Value
isMerchantStatementExportEnabled
References: Merchant Account Group.Is Merchant Statement Export Enabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether the content of the Merchant Statements List report is exported to the merchant’s FTP via the data export mechanism.
isRemittanceSourceIgnored
References: Merchant Account Group.Is Ignore Remittance Source
XML Representation: attribute
Attributes:
Default Value
Controls whether remittance source is ignored or not. If enabled, a single bank account will be used for all types of remittances and they will not be split based on the remittance source. See Remittance Source definition for additional information.
isRemittanceHoldEnabled
References: Merchant Account Group.Is Remittance Hold Enabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether remittance process is enabled. When set to true, the balance of all of the newly generated remittance statements is not sent to the merchant, but transferred under the merchant's balance.
minimumRemittanceAmount
References: Merchant Account Group.Minimum Remittance Amount
XML Representation: attribute
Attributes:
Default Value
Shows the minimum amount of funds that must be reached in order for the remittance process to occur.
isMerchantStatementArchivingEnabled
References: Merchant Account Group.Is Merchant Statement Archiving Enabled
XML Representation: attribute
Attributes:
Default Value
Indicates whether merchant statement archiving process is happening. Copies of statements are archived here: 126.
recurringFeesBeginDate
References: Merchant Account Group.Recurring Fees Begin Date
XML Representation: attribute
Attributes:
Default Value
The date when recurrent fees for a merchant begin to accrue.
feeWithdrawalPolicyType
References: Merchant Account Group.Fee Withdrawal Policy CL
XML Representation: attribute
Attributes:
Default Value
Represents the type of current (or selected) approach used to withhold fees from a merchant.
merchantStatementEmailingPolicy
References: Merchant Account Group.Statement Emailing Policy
XML Representation: attribute
Attributes:
Default Value
Enumerates possible values of statement emailing policy for the merchant account group.
maxMerchantStatementAmount
References: Merchant Account Group.MAX Merchant Statement Amount
XML Representation: attribute
Attributes:
Default Value
Maximum allowed amount of the merchant statement.
minMerchantStatementAmount
References: Merchant Account Group.MIN Merchant Statement Amount
XML Representation: attribute
Attributes:
Default Value
Minimum amount of the merchant statement.
maxReserveAdjustmentAmount
References: Merchant Account Group.MAX Reserve Adjustment Amount
XML Representation: attribute
Attributes:
Default Value
Shows the maximum amount of money that can be withheld for a single remittance to be placed in the reserve adjustments.
convenienceFeeBalance
References: Merchant Account Group.Convenience Fee Balance
XML Representation: attribute
Attributes: ReadOnly
Default Value
Shows the amount of money owed for convenience fee.

Note: This field is read-only and cannot be modified.
remittanceCurrencyCode
References: Merchant Account Group.Remittance Currency Code
XML Representation: attribute
Attributes:
Default Value
Code of currency used for remittance.
Default value: USD.
statementPolicyType
References: Merchant Account Group.Statement Policy CL
XML Representation: attribute
Attributes:
Default Value
Enumeration of possible values of statement policy for the merchant account group.
lastRemittanceDate
References: Merchant Account Group.Last Remittance Date
XML Representation: attribute
Attributes: ReadOnly
Default Value
Date when the last physical ACH transaction (deposit) was sent to the merchant. See Statements definition for additional information.
remittanceStartDate
References: Merchant Account Group.Remittance Start Date
XML Representation: attribute
Attributes:
Default Value
Start date of the remittance.
feeTemplateCode
References: Merchant Account Group.Fee Template Code
XML Representation: attribute
Attributes:
Default Value
Code of the used fee template.
remittanceHoldUserCode
References: Merchant Account Group.Remittance Hold User Code
XML Representation: attribute
Attributes:
Default Value
Code of the remittance hold user.
remittanceHoldNote
References: Merchant Account Group.Remittance Hold Note
XML Representation: attribute
Attributes:
Default Value
Any additional information about remittance hold.
annualFeePolicy
References: Merchant Account Group.Annual Fee Policy
XML Representation: attribute
Attributes: Required
Default Value
Defines a list of the months that should be available for annual fee setting for merchants under a particular portfolio.
balance
References: Merchant Account Group.Balance
XML Representation: attribute
Attributes: ReadOnly
Default Value
Shows the current balance of a merchant/merchant account. If the value is positive, 3rd party processor owes money to the merchant. If the value is negative, merchant owes money to a 3rd party processor.

Note: This field is read-only and cannot be modified.
statementViewPolicyType
References: Merchant Account Group.Statement View Policy
XML Representation: attribute
Attributes:
feesResponsibleCl
References: Merchant Account Group.Fees Responsible Cl
XML Representation: attribute
Attributes:
Default Value
remittancePeriodMada
References: Merchant Account Group.Mada Remittance Period
XML Representation: attribute
Attributes:
Default Value

XML Sample:

<remittance-config
    remittancePeriodDeposit="" 
    maximumWithholdingAmount="100" 
    merchantStatementRecipientList="johnsmith@email.com, janesmith@email.com, judiesmith@email.com" 
    merchantStatementRecipientListMonthly="johnsmith@email.com, janesmith@email.com, judiesmith@email.com" 
    isMerchantStatementExportEnabled="true" 
    isRemittanceSourceIgnored="true" 
    isRemittanceHoldEnabled="true" 
    minimumRemittanceAmount="100" 
    isMerchantStatementArchivingEnabled="true" 
    recurringFeesBeginDate="2013-12-31" 
    feeWithdrawalPolicyType="W" 
    maxMerchantStatementAmount="100" 
    minMerchantStatementAmount="1" 
    remittanceCurrencyCode="USD" 
    statementPolicyType="NA" 
    remittanceHoldNote="Note" 
    annualFeePolicy="J000YULGSOND" 
    statementViewPolicyType="ARF--DSB--" />
"<remittance-config remittancePeriodDeposit=\"\" maximumWithholdingAmount=\"100\" merchantStatementRecipientList=\"johnsmith@email.com, janesmith@email.com, judiesmith@email.com\" merchantStatementRecipientListMonthly=\"johnsmith@email.com, janesmith@email.com, judiesmith@email.com\" isMerchantStatementExportEnabled=\"true\" isRemittanceSourceIgnored=\"true\" isRemittanceHoldEnabled=\"true\" minimumRemittanceAmount=\"100\" isMerchantStatementArchivingEnabled=\"true\" recurringFeesBeginDate=\"2013-12-31\" feeWithdrawalPolicyType=\"W\" maxMerchantStatementAmount=\"100\" minMerchantStatementAmount=\"1\" remittanceCurrencyCode=\"USD\" statementPolicyType=\"NA\" remittanceHoldNote=\"Note\" annualFeePolicy=\"J000YULGSOND\" statementViewPolicyType=\"ARF--DSB--\" />"

JSON Sample:

{
  "remittancePeriodDeposit": "",
  "maximumWithholdingAmount": "100",
  "merchantStatementRecipientList": "johnsmith@email.com, janesmith@email.com, judiesmith@email.com",
  "merchantStatementRecipientListMonthly": "johnsmith@email.com, janesmith@email.com, judiesmith@email.com",
  "isMerchantStatementExportEnabled": true,
  "isRemittanceSourceIgnored": true,
  "isRemittanceHoldEnabled": true,
  "minimumRemittanceAmount": "100",
  "isMerchantStatementArchivingEnabled": true,
  "recurringFeesBeginDate": "2013-12-31",
  "feeWithdrawalPolicyType": "W",
  "maxMerchantStatementAmount": "100",
  "minMerchantStatementAmount": "1",
  "remittanceCurrencyCode": "USD",
  "statementPolicyType": "NA",
  "remittanceHoldNote": "Note",
  "annualFeePolicy": "J000YULGSOND",
  "statementViewPolicyType": "ARF--DSB--"
}

XURL Sample:

?remittancePeriodDeposit=&maximumWithholdingAmount=100&merchantStatementRecipientList=johnsmith%40email.com%2C+janesmith%40email.com%2C+judiesmith%40email.com&merchantStatementRecipientListMonthly=johnsmith%40email.com%2C+janesmith%40email.com%2C+judiesmith%40email.com&isMerchantStatementExportEnabled=true&isRemittanceSourceIgnored=true&isRemittanceHoldEnabled=true&minimumRemittanceAmount=100&isMerchantStatementArchivingEnabled=true&recurringFeesBeginDate=2013-12-31&feeWithdrawalPolicyType=W&maxMerchantStatementAmount=100&minMerchantStatementAmount=1&remittanceCurrencyCode=USD&statementPolicyType=NA&remittanceHoldNote=Note&annualFeePolicy=J000YULGSOND&statementViewPolicyType=ARF--DSB--&
remittancePeriodDeposit=
maximumWithholdingAmount=100
merchantStatementRecipientList=johnsmith@email.com, janesmith@email.com, judiesmith@email.com
merchantStatementRecipientListMonthly=johnsmith@email.com, janesmith@email.com, judiesmith@email.com
isMerchantStatementExportEnabled=true
isRemittanceSourceIgnored=true
isRemittanceHoldEnabled=true
minimumRemittanceAmount=100
isMerchantStatementArchivingEnabled=true
recurringFeesBeginDate=2013-12-31
feeWithdrawalPolicyType=W
maxMerchantStatementAmount=100
minMerchantStatementAmount=1
remittanceCurrencyCode=USD
statementPolicyType=NA
remittanceHoldNote=Note
annualFeePolicy=J000YULGSOND
statementViewPolicyType=ARF--DSB--
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.