• User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

  • User Documentation 
  • Amaryllis Release Notes 
  • For Developers 

User Guide

  • folder icon closed folder iconGetting Started
    • Logging In for the First Time
    • System Hierarchy
    • Hierarchy Usage and Summary View
    • Understand Fee and Commission
    • Understanding Reports
    • Making Configuration Easier
  • folder icon closed folder iconSystem Administration
    • Putting It All Together
    • System Setup Flow
    • Platform Account Administration
    • Platform Account Configuration
    • Service Provider Administration
    • Service Provider Configuration
    • Operator and Service Provider Branding Settings
    • Sub-Account Administration
    • Sub-Account Configuration
  • folder icon closed folder iconUser Administration
    • System Users and Functionality
    • Back Office User Administration
    • API User Administration
    • Agent Administration
    • Agent Configuration
  • folder icon closed folder iconReporting
    • Report Menu
    • Account Balance
    • Payouts
    • Payouts Reconciliation
    • Settlements
    • Approval Rate
    • Transaction Summary
    • Transactions
    • Fees Summary
    • Incoming Fees
    • Expected Future Revenue
    • Profitability Analysis Report
    • Reconciliation Summary
    • Reconciliation Records
    • Chargeback Analysis
    • Tokens Report
    • Merchant Statement
    • Management Level Reports (Operator, Service Provider, Agent, Platform)
  • folder icon closed folder iconAlerts Center
    • Rules Management
    • Alerts Management
    • Active Alerts
    • Resolved Alerts
  • folder icon closed folder iconUnderwriting Management
    • Underwriting Templates
    • Underwriting Template Configuration
    • Underwriting Application
    • Underwriting Application Configuration
    • Managing Underwriting Application
    • Sign-Up Summary
  • folder icon closed folder iconDisputes Management
    • Active Disputes
    • Resolved Disputes
  • folder icon closed folder iconTransactions Processing
    • Transaction Types
    • Import Mode
    • Echo Mode
  • folder icon closed folder iconDashboards
    • Financials
    • Management
  1. Home
  2. Docs
  3. User Guide
  4. User Administration
  5. Agent Configuration
Updated on January 26, 2023

User Guide

  • folder icon closed folder iconGetting Started
    • Logging In for the First Time
    • System Hierarchy
    • Hierarchy Usage and Summary View
    • Understand Fee and Commission
    • Understanding Reports
    • Making Configuration Easier
  • folder icon closed folder iconSystem Administration
    • Putting It All Together
    • System Setup Flow
    • Platform Account Administration
    • Platform Account Configuration
    • Service Provider Administration
    • Service Provider Configuration
    • Operator and Service Provider Branding Settings
    • Sub-Account Administration
    • Sub-Account Configuration
  • folder icon closed folder iconUser Administration
    • System Users and Functionality
    • Back Office User Administration
    • API User Administration
    • Agent Administration
    • Agent Configuration
  • folder icon closed folder iconReporting
    • Report Menu
    • Account Balance
    • Payouts
    • Payouts Reconciliation
    • Settlements
    • Approval Rate
    • Transaction Summary
    • Transactions
    • Fees Summary
    • Incoming Fees
    • Expected Future Revenue
    • Profitability Analysis Report
    • Reconciliation Summary
    • Reconciliation Records
    • Chargeback Analysis
    • Tokens Report
    • Merchant Statement
    • Management Level Reports (Operator, Service Provider, Agent, Platform)
  • folder icon closed folder iconAlerts Center
    • Rules Management
    • Alerts Management
    • Active Alerts
    • Resolved Alerts
  • folder icon closed folder iconUnderwriting Management
    • Underwriting Templates
    • Underwriting Template Configuration
    • Underwriting Application
    • Underwriting Application Configuration
    • Managing Underwriting Application
    • Sign-Up Summary
  • folder icon closed folder iconDisputes Management
    • Active Disputes
    • Resolved Disputes
  • folder icon closed folder iconTransactions Processing
    • Transaction Types
    • Import Mode
    • Echo Mode
  • folder icon closed folder iconDashboards
    • Financials
    • Management

Agent Configuration

Agent Onboarding Wizard

Agent onboarding is a three-step procedure that allows to create and/or edit Agent entities/users. The procedure consists of the following steps:

  1. General
  2. Billing
  3. Payouts

Press the Save & Continue button to save settings at the current step and proceed to the next step.

Press the Back button to return to the previous step without saving settings at the current step.

Press the Cancel button to abort onboarding without saving.

Press the Submit button to save all settings and complete the onboarding procedure.

Let us configure an Agent!

  • Go to the Agents section
  • Click ‘Add Agent’
  • Follow the three-step Agent Onboarding Wizard to create a new Agent

OR

  • Select at least one Agent 
  • Select ‘Add/Edit Agent’ in the Actions pop-up options list
  • Follow the three-step Agent Onboarding Wizard to add/edit a new Agent
1 General
2 Billing
3 Payouts
1 General

Please set basic information, contact details, and optional parent entity for an Agent. The below form applies for both Add and Edit operations, except for the Copy Settings From parameter (enabled for the Add Agent form only).

NameDescriptionOptionality
Service ProviderSelect a corresponding Service Provider from the dropdown list. Agents are created for a specific existing Service ProviderRequired
Agent NameYour Agent Name to be displayed in the systemRequired
User NameYour agent User UsernameRequired
PasswordYour Agent User PasswordRequired
First NameYour Agent User First NameRequired
Last NameYour Agent user Last NameRequired
EmailAgent contact Email AddressRequired
PhoneAgent contact Phone NumberRequired
Agent RoleSelect a role for the Agent User. Available options depend on the selected Service ProviderRequired
Platform AccountsSelect accounts your Agent will have access to. Select All to give access to all the available accounts. Available options depend on the selected Service ProviderRequired
Sub-AccountsYou can give access to more than one Sub-Account under different accounts in case you have selected more than one account in the previous step. Select All to give access to all the available Sub-Accounts. Available options depend on the selected Service Provider and account(s)Required
Copy Settings FromSelect source Agent to copy configuration settings to a new target Agent. Select None to disable all templates. Enabled for Add Agent form onlyOptional
Two-Factor AuthenticationMark this box if you require two-step verification to be applied. Enabled in case External Agent, Platform Agent, Service Provider Agent are set as Agent RoleOptional

 

2 Billing

Use Billing Onboarding section to enable and configure Agent entity fees. This step is Optional, Save and Continue to skip and proceed to the next step. In case there are no fees configured for a particular Agent, you will see a notice: Warning! No fees configured for your Agent. In the main grid expand Agent Details to view all Billing settings of the selected Agent entity.

A Fee with Fee Source=Agent should be created at the Service Provider level to become available at the Billing step of the Agents Onboarding Wizard

If you want to apply a fee with Fee Source = Agent preconfigured at the Service Provider level:

  • press the Enable button
  • specify amount and/or percentage of the fee
  • select type or types of transactions on which reversal is required.

If you want to disable such fee, press the Disable button.

 

3 Payouts

Use Payouts Onboarding section to create and configure Regular and Negative Payouts Instructions for Agents. A specific payout instruction can be created for each of the system currencies. Payouts is an optional step where you can configure your Agent payout instructions.

Payout Bank is determined automatically based on the Service Provider and the currency type

Payout Configuration Details Explained

The Payout section is split into two sections:

  • Payout Configuration
  • New Payout
Click Skip and Continue to move to the next step. You can Add/Edit your Agent payouts instructions any time later

PAYOUT CONFIGURATION

Configure manual and automated payout options, payout processor, and payout processor parameters. Use Balance management to configure Negative Payouts.

Payouts Configuration Details

NameDescription
Payout ProcessorSelect a Payout processor from the drop-down list or select None to enable manual payouts. Available options are based on the selected Service Provider. External payouts processor is disabled if manual payout (None) option is selected. Manual payouts are manually approved in the Back-Office Payouts report
Balance ManagementBalance Management allows configuring payout actions based on the balance value
Check Account BalanceSelect to enable account balance check prior to the payout. In case enabled, negative payouts are disabled
Ignore Account BalanceSelect to ignore account balance value for processing payouts. Required to enable negative payouts
Perform Negative Payout (Withdrawal) if Account Balance is NegativeIn case selected together with Ignore Account Balance and the returned account balance calculated amount is negative – negative payout transaction is processed

In case Negative Payouts are enabled for an Agent, it will be displayed in the Confirmation Onboarding step in the Payout Settings tab.

NEW PAYOUT CONFIGURATION

PAYOUT (ACH BANK) DETAILS

It is possible to create one payout configuration per currency type.

Available Actions:

Add Payout: use to add an additional payout
Edit Payout Method Name: use to edit an existing payout name
Hide/Show: use to hide/show a payout configuration
Remove: use to delete a payout configuration
NameDescription
Payment MethodSelect a Payment Method for the payout from the drop-down list
ACH Details All fields are required. Displayed in case ACH is selected
  1. Account Number — ACH account number
  2. Account Type — ACH account type (Checking/Savings)
  3. Routing Number — ACH bank routing number
  4. Entity Type — ACH entity type (Personal/Business)
  5. Name on Account — Account name

PAYOUT SCHEDULER

The Payout Scheduler enables you to configure the Time Schedule for Payouts you want to apply to your Agent.

NameDescription
Payout Scheduler Automated Payout Interval Options
  1. Daily — Enter a day sequential number in the text box
  2. Weekly — Enter a week sequential number and select a weekday in the drop-down
  3. Monthly — Enter a payout day and month sequential number in the appropriate text box
  4. Yearly — Enter a payout year, month, and day in the appropriate text box
Payout Scheduler Automated Payout Expiration Options
  1. Until Date – Select End date in the date picker box
  2. Number of occurrences – Enter number of occurrences in the Occurrences quantity text box
  3. Never — Select to enable an endless payout option

PAYOUT AND RESERVE MANAGEMENT

You can preset payout amount calculation mode and time range to create a rolling reserve according to your risk management policy. There are 4 Payout Types you can choose from:

  • Fixed — Set a fixed payout amount
  • Percentage — Rolling Reserve Payout amount is calculated as a percentage from the Account Balance
  • Past Date — The payout amount is calculated as an Account Balance on a specific date, considering the preset reserve capacity
  • Past Interval — Payout amount is calculated from the total amount of daily settlements, incoming fees, adjustments, reserve balance release, on-demand payouts, and cancelled payouts transactions for the specified time range

CONFIGURING TWO-STEP APPROVAL FOR PAYOUTS

Enable Two-step approval to have an option to manually approve or decline suspicious payout transactions.

NameDescription
Two-Step approval (semi-automated payout)Select to enable an additional manual payout confirmation via the Back-Office. Use to add a manual payout approval for automated payouts processed with an external processor or to add an additional manual approval for manual payouts.
Still stuck? How can we help?
Was this page helpful? Yes No

How can we help?

© Amaryllis Payment Solutions, 2022  All rights reserved.