Interface IMoneyOutService
Service for handling associate's commision payout accounts.
Namespace: DirectScale.Disco.Extension.Services
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public interface IMoneyOutServiceMethods
AutoProvisionAccount(Int32, Int32)
Calls the merchantId's implementation code to create an a new account for associateId.
Declaration
Task<OnFileMerchant> AutoProvisionAccount(int associateId, int merchantId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | associateId | Associate Id to create account for. |
| System.Int32 | merchantId | Merchant to create account with. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OnFileMerchant> | New account details. |
GetCustomValues(Int32, Int32)
Gets associateId's account values with merchantId.
Declaration
Task<IReadOnlyDictionary<string, string>> GetCustomValues(int associateId, int merchantId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | associateId | Associate to get account for. |
| System.Int32 | merchantId | Merchant with account. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>> | Merchant specific information for associate's account. |
GetCustomValuesActive(Int32)
Gets the account values for associateId's active commission merchant.
Declaration
Task<IReadOnlyDictionary<string, string>> GetCustomValuesActive(int associateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | associateId | Associate with commission account. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.String, System.String>> | Merchant specific information for associate's account. |
GetOnFileMerchants(Int32)
Get the commission merchants that this associate has on file.
Declaration
Task<OnFileMerchant[]> GetOnFileMerchants(int associateId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | associateId |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<OnFileMerchant[]> | Array of OnFileMerchant. |
SetActiveOnFileMerchant(OnFileMerchant)
Sets MerchantId as AssociateId's active commission payment merchant. Also sets the associate's payment account information using CustomValues.
Declaration
Task SetActiveOnFileMerchant(OnFileMerchant accountInfo)Parameters
| Type | Name | Description |
|---|---|---|
| OnFileMerchant | accountInfo | The associate, their active merchant, and their account info with that merchant. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |
SetActiveOnFileMerchantPreference(Int32, Int32)
Sets MerchantId as AssociateId's active commission payment merchant preference. This will set the preference so that when a person next pays out, an account will be provisioned if it does not exist.
Declaration
Task SetActiveOnFileMerchantPreference(int associateId, int merchantId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | associateId | Associate ID for which to set the money-out preference |
| System.Int32 | merchantId | Merchant ID to set as money-out preference |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task |