Class CommissionPayment

Represents the status of an individual commission payment.

Inheritance
System.Object
CommissionPayment
Namespace: DirectScale.Disco.Extension
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public class CommissionPayment : Object

Constructors

CommissionPayment()

Declaration
public CommissionPayment()

Properties

Amount

The amount of the payment.

Declaration
public Decimal Amount { get; set; }
Property Value
Type Description
System.Decimal

AssociateId

The associate this payment is for.

Declaration
public int AssociateId { get; set; }
Property Value
Type Description
System.Int32

BatchId

Identifies which batch this payment is part of.

Declaration
public int BatchId { get; set; }
Property Value
Type Description
System.Int32

CheckNumber

This will be shown to the user as a reference or confirmation number.

Declaration
public int CheckNumber { get; set; }
Property Value
Type Description
System.Int32
Remarks

Usually only applies to Check merchants.

CountryCode

The country the associate is in.

Declaration
public string CountryCode { get; set; }
Property Value
Type Description
System.String
See Also

DatePaid

The date the payment was paid.

Declaration
public string DatePaid { get; set; }
Property Value
Type Description
System.String

Details

More specific details if this payment is for multiple orders.

Declaration
public List<CommissionPaymentDetail> Details { get; set; }
Property Value
Type Description
System.Collections.Generic.List<CommissionPaymentDetail>

ErrorMessage

Reason why the payment failed, otherwise empty.

Declaration
public string ErrorMessage { get; set; }
Property Value
Type Description
System.String

ExchangeCurrencyCode

The currency used to pay out.

Declaration
public string ExchangeCurrencyCode { get; set; }
Property Value
Type Description
System.String

ExchangeRate

The exchange rate of the currency used to pay out.

Declaration
public Decimal ExchangeRate { get; set; }
Property Value
Type Description
System.Decimal

Fees

Fees charged for this payment.

Declaration
public Decimal Fees { get; set; }
Property Value
Type Description
System.Decimal

Holdings

Amount witheld from the associate.

Declaration
public Decimal Holdings { get; set; }
Property Value
Type Description
System.Decimal

Id

Represents the DB record number for this payment. PaymentUniqueId is more commonly used.

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

MerchantCustomFields

These are the values for the custom fields specific to each merchant.

Declaration
public Dictionary<string, string> MerchantCustomFields { get; set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, System.String>
See Also

MerchantId

Indicates which merchant will process this payment.

Declaration
public int MerchantId { get; set; }
Property Value
Type Description
System.Int32

Notes

Returns the first value of Details notes: Notes

Declaration
public string Notes { get; }
Property Value
Type Description
System.String

PaymentStatus

The status of the payment.

Declaration
public PaymentProcessStatus PaymentStatus { get; set; }
Property Value
Type Description
PaymentProcessStatus

PaymentUniqueId

A unique identifier, unique to each payment processed.

Declaration
public string PaymentUniqueId { get; set; }
Property Value
Type Description
System.String
Remarks

Assigned by Direct Scale when the payment begins processing.

This number will be unique each time if the payment fails and needs to be reprocessed.

TaxId

The associate's social security number or tax id.

Declaration
public string TaxId { get; set; }
Property Value
Type Description
System.String

Total

The total amount the assocaite was payed (Amount less fees and witholdings).

Declaration
public Decimal Total { get; set; }
Property Value
Type Description
System.Decimal

TransactionNumber

The transaction number tracking this payment.

Declaration
public string TransactionNumber { get; set; }
Property Value
Type Description
System.String
Remarks

This is usually the 3rd party merchant's transaction number. This identifier links DirectScale's record of the transaction to the transaction information available from the external payment processing entity.

When passed into it will usually be empty the first time a payment is attempted, but will contain the previous attempt's transaction number if it is attempting to re-process payment.