About This Guide {#anet-on-vap-merchant-boarding-quick-start-guide-about}
=========================================================================

This section describes this guide and where to find further information.

Audience and Purpose
:
This guide is intended for merchants on the Visa Acceptance platform.

Conventions
:
This statement appears in this document:

    > An *Important* statement contains information essential to successfully completing a task or learning a concept.

Recent Revisions to This Document {#reference.dita_bf7f009c-6cb6-42c4-9fc7-edcc89310919}
========================================================================================

26.04.1
-------

Added how to accept or reject transactions that are held for review.
:
See [Accepting or Rejecting a Transaction Held for Review](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/trx-held-review.md "").

Added how to manage recurring payments, such as subscriptions and plans.
:
See [Recurring Billing](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/recur-billing-sub-manage-update.md "").

26.03.1
-------

Initial version.
:

Payment Center {#anet-on-vap-payment-center-intro}
==================================================

The Merchant Experience enables you to take payments and manage transactions that represent payments.  
The following options are available in the Payment Center:

[Take a Quick Payment](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/take-quick-pmt.md "")
:
Charge a card with basic payment information.

[Take an Itemized Sale](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/take-itemized-sale.md "")
:
Charge a card to pay for a specific item, with optional freight and duty added.

[Search for Transactions](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/payment-center-trx-filters.md "")
:
Find information about your transactions.

Search for Pay by Link
:

Search for Invoices
:

[Manage Subscriptions](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/recur-billing-sub-manage-update/manage-subscription.md "")
:
Create, edit, suspend, reactivate, cancel, and restart subscriptions.

[Capture an Authorize Only Transaction](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/capture-auth.md "")
:
Queue an Authorize Only transaction for settlement.

[Void a Transaction](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/void-trx.md "")
:
Cancel a payment before it settles.

[Refund a Transaction](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/payment-center-intro/refund-trx.md "")
:
Refund part or all of the amount of the transaction back to the customer.

Take a Quick Payment {#anet-on-vap-quick-payment}
=================================================

Follow these steps to accept a payment without itemized details.

1. Click Payment Center.

2. Click Take a Payment.

3. Select a curency and enter the amount of the payment.

4. Enter a transaction description if desired.

5. Check Authorize only if you want to manually capture the payment for settlement at a later time.

6. Search for a customer if you want to include the information for an existing customer, or click Add new customer and enter the customer name and address if you want to add a new customer.

7. Enter the card number, expiration date, and security code..

   #### ADDITIONAL INFORMATION

   The security code is the three-digit code found on the back of the payment card, next to the cardholder signature. For American Express cards, the security code is four digits and is found on the lower right corner of the front of the card.

8. Check Add billing and shipping information if you did not include a customer previously and if you want to include the billing and shipping information with this payment.

   1. Enter the first and last name.

   2. Begin typing the street address.

      #### Step Result

      Suggested street addresses appear. Click the address for the customer when it appears.

   3. Check Use a different shipping address if the shipping address is different from the billing address. Enter the first and last name, and begin typing the street address.

      #### Step Result

      Suggested street addresses appear. Click the address for the recipient when it appears.

   #### ADDITIONAL INFORMATION

   Applicable tax rates may vary depending on the billing or shipping address.

9. Click Edit if you want to change the tax jurisdiction.

   #### ADDITIONAL INFORMATION

   Select the tax jurisdiction, select the tax type or types, and enter the tax rate or rates. Click Save to save the tax jurisdiction and tax rate or rates.

10. Click Charge.

11. Click Take new payment if you want to take another payment, or click Transaction details to view the transaction details.

#### RESULT

The payment is submitted. If you did not check Authorize only, the transaction settles automatically.

Take an Itemized Sale {#anet-on-vap-itemized-sale}
==================================================

Follow these steps to accept a payment with itemized details.

1. Click Payment Center.

2. Click Take a Payment.

3. Click Itemized sale

4. Select a currency.

5. Enter a transaction description if desired.

6. Check Authorize only if you want to capture the payment manually for settlement at a later time.

7. Click Add item or service.

   1. Enter an item ID number, item name, quantity, and unit price.

   2. Click Add discount if you want to include a discount.

      #### ADDITIONAL INFORMATION

      Select whether you want the discount to be an amount based on a currency or percentage, and enter the amount of the discount.

   3. Click Edit if you want to change the tax jurisdiction.

      #### ADDITIONAL INFORMATION

      Select the tax jurisdiction, select the tax type or types, and enter the tax rate or rates. Click Save to save the tax jurisdiction and tax rate or rates.

   4. Click Save item.

8. Repeat the previous step if you have more items or services to add.

9. Search for a customer if you want to include the information for an existing customer, or click Add new customer and enter the customer name and address if you want to add a new customer.

10. Enter the card number, expiration date, and security code..

    #### ADDITIONAL INFORMATION

    The security code is the three-digit code found on the back of the payment card, next to the cardholder signature. For American Express cards, the security code is four digits and is found on the lower right corner of the front of the card.

11. Check Add billing and shipping information if you did not include a customer previously and if you want to include the billing and shipping information with this payment.

    1. Enter the first and last name.

    2. Begin typing the street address.

       #### Step Result

       Suggested street addresses appear. Click the address for the customer when it appears.

    3. Check Use a different shipping address if the shipping address is different from the billing address. Enter the first and last name, and begin typing the street address.

       #### Step Result

       Suggested street addresses appear. Click the address for the recipient when it appears.

    #### ADDITIONAL INFORMATION

    Applicable tax rates may vary depending on the billing or shipping address.

12. Click Add freight/shipping if freight or shipping applies, and enter the freight/shipping amount.

    #### ADDITIONAL INFORMATION

    Freight and shipping do not apply for services.

13. Click Add duty if duty applies, and enter the duty amount.

    #### ADDITIONAL INFORMATION

    Duty does not apply for services.

14. Click Charge.

15. Click Take new payment if you want to take another payment, or click Transaction details to view the transaction details.

#### RESULT

The payment is submitted. If you did not check Authorize only, the transaction settles automatically.

Transaction Summary and Filters {#anet-on-vap-payment-center-trx-filters}
=========================================================================

The Transactions tab of the Payment Center provides a view of your transactions and their statistics. It also lets you view your transactions with various filters as well as search for specific transactions.  
The date filter lets you view transactions and statistics over the date range of your preference. The date range options are:

* Today
* Last 7 days
* Last 30 days
* Last 3 months
* Last 6 months
* Last year
* A custom date range determined by dates you set in the interface
  {#anet-on-vap-payment-center-trx-filters_ul_o3q_ylc_s3c}  
  The Transactions tab shows your total revenue, total transaction count, and total refunds processed over the date range that you choose.  
  If you have transactions held for review due to potential fraud, or if you have transactions that are pending capture, a prompt appears with the transaction count. Click Show to see the transactions in question.  
  The search field enables you to search transactions by customer name, card number, or transaction amount.  
  The source filter enables you to find transactions based on how the transaction is generated:

Online
:
Transactions that originated through your website integration

In-person
:
Transactions that originated at a point-of-sale terminal

Invoice
:
Transactions that originated from an invoice that you sent the customer

Recurring
:
Transactions that originated from a subscription

Link
:
Transactions that originated from a Pay By Link
{#anet-on-vap-payment-center-trx-filters_dl_gtb_fnc_s3c}  
The type filter enables you to find transactions based on the transaction type:

Sale
:
Charge transactions that are queued to settle automatically

Refund
:
Refund transactions

Void
:
Transactions that are voided

Authorization
:
Transactions that are pending capture  
The status filter enables you to find transactions based on transaction status:

Success
:
Transactions that are successfully processed

Error
:
Transactions that failed due to an error

Declined
:
Transactions that have been declined

Held for review
:
Transactions that are held due to potential fraud

Pending
:
Transactions that are pending settlement
{#anet-on-vap-payment-center-trx-filters_dl_hgt_24c_s3c}  
Click the column headings to sort transactions by that value.  
Use the pagination controls to determine how many transactions appear on each page, and also to search for transactions manually.

Capture an Authorization {#anet-on-vap-refund-trx}
==================================================

Follow these steps to capture an authorization for settlement:

1. Click Payment Center.
2. Under Type, select Authorization.
3. Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
4. Click ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) and select Capture payment.

#### RESULT

The authorization is captured for settlement.

Void a Transaction {#anet-on-vap-void-trx}
==========================================

Follow these steps to void a transaction:

1. Click Payment Center.
2. Under Status, select Pending.
3. Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
4. Click ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) and select Void transaction.
5. Confirm that you want to void this transaction and click Void transaction, or click Cancel if you decide not to void the transaction.

#### RESULT

The transaction is voided. Funds held during authorization are released back to the cardholder within a week.

Refund a Transaction {#anet-on-vap-refund-trx}
==============================================

Follow these steps to refund a transaction:

1. Click Payment Center.

2. Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.

3. Click ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) and select Refund transaction.

4. Confirm that you want to email a receipt to the customer. Uncheck Email transaction receipt to customer if you do not want to send an email receipt. Update the customer's email if necessary.

5. Enter the refund amount if you want to submit a partial refund.

   #### ADDITIONAL INFORMATION

   The refund amount defaults to the full amount of the original transaction.

6. Enter a reason for the refund if desired.

7. Click Submit refund, or click Cancel if you decide not to refund the transaction.

#### RESULT

The transaction is refunded.

Accepting or Rejecting a Transaction Held for Review {#anet-on-vap-trx-held-review}
===================================================================================

Follow these steps to accept or reject a transaction that is held for review:

1. Click Payment Center.
2. Under Status, select Held for review.
3. Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
4. Click ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) and select Accept transaction if you want to process the transaction as usual, or select Reject transaction if you want to prevent the transaction from processing.

#### RESULT

The transaction is accepted or rejected.

Recurring Billing {#recurring_billing_subscription_management_update}
=====================================================================

[Recurring payments](# "") are ongoing payments between merchants and their customers. You as the merchant create and manage [plans](# "") and [subscriptions](# "") to provide this payments model to customers.  
Plans are templates that you can configure to customize the pricing, billing frequency, and duration of recurring payments. You can create and manage multiple plans simultaneously to offer a variety of recurring payment options to their customers.  
Subscriptions are the active billing agreement between business and customer, when a customer is assigned to a plan. When you create a subscription, you choose or create a customer account, select a plan, and apply a start date.

Plan Details {#plan_details}
============================

To view plan details, go to the Plans tab in the main dashboard. Select a plan to view additional details. Plan information includes these details:

Plan name
:
Plan name shows the current name of the plan, which is initially designated at the time of its creation. It can be changed by later altering it.

Plan description
:
Plan description shows an optional field that gives further details regarding the plan.

Status
:
Status shows whether the plan is currently Active or Inactive.

Amount
:
Amount shows the cost in the plan's selected currency, for subscribed customers' billing purposes.

Frequency
:
Frequency shows the period of time selected for the plan's billing cycle, indicating how often and when a fee will be charged to a subscribed customer.

Billing duration
:
Billing duration shows the length of the plan's subscription period.

Active subscriptions
:
Active subscriptions shows the number of customers actively subscribed to the plan at the moment that it is viewed.

Setup fee
:
Setup fee shows whether an optional initial fee will be charged to a customer who subscribes to the plan.

Subscriptions for \[Plan name\]
:
Subscriptions for \[Plan name\] shows the number of customers currently subscribed to the chosen plan and an itemized list of each currently subscribed customer's subscription number, name, and next billing date for each subscription.  
You can choose whether to edit the terms and details of a plan, deactivate a plan, or delete a plan entirely.

Create a Plan {#recurring_billing_plans_process}
================================================

Follow these steps to create a plan:

1. Sign in to the dashboard.
2. Click the Plan name text box, and type the plan name.
3. (Optional) Click the Plan description text box, and type a plan description.
4. From the Amount drop-down menu, choose a currency.
5. From the Frequency drop-down menu choose the billing frequency. If you choose a custom frequency, follow Steps **a** and **b**. If you do not choose a custom frequency, skip to Step 6.
   1. Set the billing frequency. Click the Repeat every text box, and enter a repetition number.
   2. From the drop-down menu, choose the type of time period.
6. From the Billing cycles drop-down menu, choose Indefinite or Set number of billing cycles. If you choose Set number of billing cycles, follow Step **a** . If you choose Indefinite, skip to the optional Step 7.
   1. Click the Billing Cycles text box, and type the billing cycle number.
7. (Optional) To include an initial setup fee, click the Setup fee text box, and type the initial setup fee.

Edit a Plan {#edit_a_plan}
==========================

The Edit plan option enables you to modify an existing plan's details. To edit a plan, navigate to the Plans tab, select the plan you wish to edit, and click Edit plan. Use the Edit plan feature to update Plan details and billing settings:

Plan name
:
Plan name enables you to alter the name of the selected plan by clicking in the text field that shows the current Plan name and typing in the alterations.

Plan description
:
Plan description enables you to modify the optional field used to add further details concerning any aspects of the plan.

Amount
:
Amount enables you to modify the currency and the amount to be charged to a customer when they subscribe to the plan. A modification to this field impacts only future rather than existing subscriptions.

Frequency
:
Frequency enables you to alter the billing period for the selected plan, altering the time between charges to customers. A modification to this field impacts only future subscriptions.

Billing duration
:
Billing duration enables you to alter the duration of the selected plan, but you cannot reduce this value after it is initially set. Updating the Billing duration impacts only future subscriptions.
> You can alter the Billing duration only if it is not set to Indefinite, and the Billing duration cannot be altered from a finite number of cycles to Indefinite. If the Billing duration value is finite, you can alter the Billing cycles value only by increasing the number of cycles.

(Optional) Setup fee
:
This fee enables you to include a one-time charge that is applied to the first subscription payment. If you update this fee amount, existing subscribers are not affected.
{#edit_a_plan_dl_vpb_sny_q3c}  
When all changes are made, the Plan summary displays the amount that a customer will be charged, how frequently, and for how long.

Manage Plans {#manage_plans}
============================

You can manage a plan by creating subscriptions, activating or deactivating a plan, and deleting a plan. Follow these steps to manage plans:

1. To create a new subscription in an existing plan, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column. Choose Create Subscription from the drop-down menu. For more information about creating subscriptions see the [Create Subscription](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/recur-billing-sub-manage-update/create-subscription.md "") section.

2. To activate a plan, choose the inactive plan you want to activate, and click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column. Choose Activate Plan from the drop-down menu.

3. To deactivate a plan, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column, and choose Deactivate Plan. Click Deactivate Plan in the confirmation box.

   #### ADDITIONAL INFORMATION

   > When you deactivate a plan, the existing subscriptions associated with the plan are not impacted. You cannot create new subscriptions for inactive plans.

4. To delete a plan, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column, and click Delete Plan. In the confirmation box, click Delete Plan.

   #### ADDITIONAL INFORMATION

You cannot delete a plan if it is used in one or more subscriptions. If you click **Delete Plan** , the *This plan can't be deleted* message displays.

Create a Subscription {#create_subscription}
============================================

Follow these steps to create a subscription:

1. Select Payment Center, click the plus symbol menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-add2.svg/jcr:content/renditions/original) ) in the dashboard. Select Create Subscription.
2. In the Create Subscription interface, select the drop-down field under Customer. Search for and select an existing customer to add to a new subscription.
   1. To add a new customer, select the field under Customer. Choose Add new customer at the bottom of the drop-down menu. The Add customer window appears.
   2. Select the displayed fields individually, and enter the information for the customer.
   3. Select the Billing address field. Click Add new address at the bottom of the list, and search for the address or enter it manually. When the address is entered, click Save.
   4. (Optional) After entering the customer's address, you can create a shipping address different from the billing address by unchecking the box next to Shipping address same as billing and entering the shipping address.
   5. (Optional) You can enter the Customer reference ID and/or Phone information for the customer in the fields beneath Additional details.
3. To enter the subscription name, click the field under Subscription name, and enter the name of the subscription, or you can keep the name generated for the subscription unchanged.
4. Under Plan, click the drop-down menu, and choose the plan to which you are attaching the subscription.
5. (Optional) To review the details of the selected plan, click View plan details. This displays the plan's cost, billing frequency, billing duration, and other information.
6. Select the date on which the subscription starts.
7. Click Save Subscription.

Subscription Details {#subscription_details}
============================================

You can view and interact with the details of all registered subscriptions. By navigating through Subscriptions details, you can find information such as the status of a subscription, a subscription's payment history, whether a subscription is delinquent, the details of a subscription's associated plan, and more. Follow these steps to view Subscription details:

1. To view all registered subscriptions, select Payment Center, and select Subscriptions.
2. Select a subscription to view its details.
3. To suspend a subscription, click Suspend subscription. When the confirmation window appears, click Suspend Subscription.
   1. To reactivate a subscription, select a suspended account. Click Reactivate subscription. When the confirmation window appears, click Reactivate Subscription.
4. To review the Payment history for the last 12 months of a subscription's activity, click Show more under Payment history within Subscription details.
5. If a subscription has a Delinquent status, you can click the lowercase i next to the subscription's status to view why it is delinquent.
6. To view the Plan details associated with a subscription, select the associated \[Plan name\] next to Plan within Subscription details.
7. To review an individual transaction, select Transactions under Payment Center.

Edit a Subscription {#edit_subscription}
========================================

You can alter the values of a subscription by using the Edit subscription option. These values include the customer's name and details, the subscription name, the associated plan, and the subscription's start and end date. Follow these steps to edit a subscription: You can edit a subscription only if its first payment is not yet processed. If a payment is processed, you can cancel the subscription and manually recreate it using the methods discussed in [Create Subscription](/docs/anetvap/en-us/smb-merchant/user/all/na/vas-smb-olh-merchant/recur-billing-sub-manage-update/create-subscription.md "").

1. To begin editing a subscription, click Payment Center and select Subscriptions.

2. Select the subscription you wish to edit.

3. Click Edit subscription.

4. Within the Edit Subscription interface, select the field(s) to modify, and enter the modified information.

   #### ADDITIONAL INFORMATION

   > You can alter only the Subscription name if the subscription has processed its first payment.

5. If the subscription has already processed a payment, you can manually recreate it. Click Cancel and create new subscription under View plan details, and click Cancel Subscription to cancel the subscription.

Manage a Subscription {#manage_subscription}
============================================

Managing a subscription involves interacting with many of the menu options available for subscriptions, including editing, suspending, reactivating, cancelling, and restarting subscriptions. You can also view subscription summaries and interact with tooltips that provide more comprehensive information regarding both plans and subscriptions. Follow these steps to manage a subscription:

1. To begin managing a subscription, navigate to the Payment Center, and click Subscriptions.

2. To view a description of plans and how they work together, click How do plans and subscriptions work?.

   #### ADDITIONAL INFORMATION

   > The Subscription summary section displays within the Subscriptions section. It shows the Average yearly total, which is the total amount you will earn over the course of the year with all active subscriptions. It shows also the Total Subscriptions and the total number of Suspended Subscriptions.

3. Within the subscriptions list, choose a subscription to manage.

4. Under Actions, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) to view the subscription's management options.

   #### ADDITIONAL INFORMATION

   * For Active status subscriptions, the View details, Edit Subscription, Suspend subscription, and Cancel subscription menu options display.
   * For Suspended status subscriptions, the View details, Reactivate subscription, and Cancel subscription menu options display.
   * For Pending status subscriptions, the View details, Edit subscription, and Cancel subscription menu options display.
   * For Cancelled status subscriptions, the View details and Restart Subscription menu options display.
5. To filter subscriptions based upon Frequency, click the Frequency drop-down menu, and choose the desired filter(s).

6. To filter subscriptions based upon Status, click the Status drop-down menu, and choose the desired filter(s).

7. To suspend an Active status subscription, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) drop-down for the subscription, and select Suspend subscription. When the confirmation window appears, click Suspend Subscription.

8. To cancel a subscription, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) drop-down for the subscription, and select Cancel subscription. When the confirmation window appears, click Cancel Subscription.

Settings Overview {#settings_overview}
======================================

Use the settings dashboard to customize and manage your organization. You can review and modify this information:

* Account profile
* Business information
* Payment preferences
* User information
* API integrations
  {#settings_overview_ul_bfp_l34_w3c}

My Profile {#my_profile}
========================

The My profile module enables you to review and modify your account's profile information. This information includes your profile's name, password, email address, mobile number, and time zone preferences. This section describes how to view and alter these details.

Edit Profile Name {#edit_profile}
=================================

Follow these steps to edit your profile name:

1. To navigate to your profile information, either click the tab that contains your profile name and an arrow symbol ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-arrow-next.svg/jcr:content/renditions/original) ), or click the Settings tab and select My Profile.
2. To edit your profile name, click the pencil icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-edit.svg/jcr:content/renditions/original) ) next to your profile name.
   1. The first and last name input fields appear. Enter your first and last name.
   2. Click Save. When the merchant account has been succesffully created, a save validation message appears.
      {#edit_profile_substeps_fgs_syv_53c}{#edit_profile_edit_profile_01}
      {#edit_profile_edit_profile_01}

Change Profile Password {#change_password}
==========================================

Follow these steps to change your profile's password:

1. To navigate to your profile information, click the tab that contains your profile name and an arrow symbol ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-arrow-next.svg/jcr:content/renditions/original) ), or click the Settings tab and select My Profile.
2. To change your password, click Change password.
   1. The Change password page opens.

   2. Click the **Current password** field, and enter your current password.

   3. Click the **New password** field, and enter your new password.

   4. Click the **Confirm new password** field, and re-enter the new password.

      #### ADDITIONAL INFORMATION

      > Your new password must meet the requirements listed under *Password must* on the Change password page.

   5. Click Save. A save validation message appears.
      {#change_password_substeps_xdl_rzv_53c}{#change_password_change_password02}
      {#change_password_change_password02}

Update Profile Email Address {#update_email_address}
====================================================

Follow these steps to update your profile's email address:

1. To navigate to your profile information, either click the tab that contains your profile name and an arrow symbol ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-arrow-next.svg/jcr:content/renditions/original) ), or click the Settings tab and select My Profile.
2. To update your email information, click the pencil icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-edit.svg/jcr:content/renditions/original) ) next to your email address.
   1. The Update email address page appears.

   2. Click the **New email address** field, and enter your new email address.

   3. Click the **Confirm new email address** field, and re-enter the new email address.

   4. Click the **Enter your password field**, and enter your profile password.

   5. Click Save.

   6. When the Enter verification code prompt appears. Find the verification code sent to your email address, and enter that code at the Enter verification code prompt.

      #### ADDITIONAL INFORMATION

      > If you do not receive an email containing the verification code within a reasonable time, click the Resend code link.

   7. Click Verify code. A save validation message appears.

      #### ADDITIONAL INFORMATION

      > If you do not successfully complete the verification process, an orange *Not verified* tag appears under your email address. When the process is completed successfully, a green *Verified* tag appears instead.
      > {#update_email_address_substeps_jnh_y2w_53c}{#update_email_address_update_email03}
      > {#update_email_address_update_email03}

Update Profile Mobile Number {#update_mobile_number}
====================================================

Follow these steps to update your mobile phone number:

1. To navigate to your profile information, click the tab that contains your profile name and an arrow symbol ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-arrow-next.svg/jcr:content/renditions/original) ), or click the Settings tab and select My Profile.
2. To update your mobile phone number, click the pencil icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-edit.svg/jcr:content/renditions/original) ) next to your phone number.
   1. The update mobile number page appears.

   2. Click the **New mobile number** field, and enter your new mobile number.

   3. Click the **Confirm new mobile number** field, and enter the same mobile number.

   4. Click the **Enter your password** field, and enter your profile's password.

   5. Click Next.

   6. When the two-step authentication prompt appears. Find the verification code sent to your mobile phone. Enter the eight-digit verification code in the Verification code prompt.

   7. Click Submit. A save validation message appears.

      #### ADDITIONAL INFORMATION

      > If you do not successfully complete the verification process, a *Not verified* tag appears under your mobile number. When the process is completed successfully, a Verified tag appears instead.
      > {#update_mobile_number_substeps_qyp_tfr_v3c}

Edit Profile Time Zone {#edit_preferences}
==========================================

Follow these steps to update your time zone preferences:

1. To navigate to your profile information, click the tab that contains your profile name and an arrow symbol ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-arrow-next.svg/jcr:content/renditions/original) ), or click the Settings tab and select My Profile.
2. In the Preferences section, click the Time zone drop-down menu.
3. Choose a time zone.
4. 3. Click Save. A save validation message appears.

My Business {#my_business}
==========================

The My business module displays your company's name, business contact information, website, address, and logo upload interface and enables you to modify them. This section describes how to view, alter, and save your business information.

Edit Business Contact Information {#edit_business_contact}
==========================================================

Follow these steps to edit your business contact information:

1. From the Settings tab, click My business.
2. On the My business page, click Edit.
3. To change your business phone number, perform the following actions:
   1. Click the country code drop-down menu, and choose a code.
   2. Select the **Phone number** field, and enter the phone number.
   3. Click Save. A save validation message appears.
4. To change your business email address, perform the following actions:
   1. Select the **Email address** text field, and enter the email address.
   2. Click Save. A save validation message appears.
      {#edit_business_contact_substeps_r3q_qqn_w3c}
5. To change the business website, perform the following actions:
   1. Select the **Website** text field, and enter the website URL.
   2. Click Save. A save validation message appears.
      {#edit_business_contact_substeps_gmw_wqn_w3c}

Upload a Logo {#uploading_a_logo}
=================================

Follow these steps to upload or change the logo for your business:

1. From the Settings tab, click My business.

2. In the Upload logo section, click the Drag and drop your logo or click to browse box, or drag an image from your image source to the box, and drop it. When you choose a file to upload and place it in the upload box, a preview of the image appears.

   #### ADDITIONAL INFORMATION

   > You can use only images that are 2 MB or smaller. Images must be in one of the following file types: GIF, PNG, SVG, or JPEG. No other file types are accepted for your logo.

3. Click Save. A save verification message appears.

Payments {#payments}
====================

The Payments module enables you to view and alter the chosen currency for your business. This section describes how to view and edit this preference.

Edit Payment Preferences {#editing_pay_prefs}
=============================================

Follow these steps to edit your payment preferences:

1. From the settings tab, click Payments.
2. Click the **Default currency** drop-down menu, and choose **USD** or **CAD**.
3. Click Save. A save verification message appears.

User Management {#user_management}
==================================

The User Management window displays all users as well as their roles and permissions. You can add, view, edit, enable, disable, or delete users and add or review user-associated permissions. This section describes how to add, view, alter, and delete users.

Add a User {#managing_users}
============================

Follow these steps to add a user:

1. From the Settings tab, click User management.

2. Click Add user.

3. Enter the name, username, email address, and phone number for each user.

4. Click the Select a role drop-down menu, and choose a role for the user.

   #### ADDITIONAL INFORMATION

   > When you choose a role for a new user, a View role permissions drop-down menu appears. You can review the role's permissions by clicking this drop-down menu. You cannot modify permissions from this interface.

5. (Optional) In the **Job title** field, and enter the user's job title.

6. Click Add user. A save verification message appears.

   #### ADDITIONAL INFORMATION

When you complete this action, a verification email is sent to the user's listed email address. The user must take action on this verification email within 24 hours for the add user process to complete successfully.

View and Edit a User {#viewing_and_editing_a_user}
==================================================

Follow these steps to view or edit a user:

1. From the Settings tab, click User management.

2. From the Users tab of the User Management window, click on a username.

3. (Optional) To search for a specific user, click the **Search user by name or email** field, and enter the user's name or email address.

4. (Optional) To organize the table based upon a specific column value, click a column title. You can filter the table order by clicking Date created, Username, Name, Role, Email, or Status. Click a value once for ascending, twice for descending, and a third time to reset the value to its default order.

5. Click the row containing the user's information. The User profile page appears for that user.

   #### ADDITIONAL INFORMATION {#viewing_and_editing_a_user_editing_user1}

   > You can edit the user's information also within the Actions column. In the row containing the user's information, click the three-dot icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ), and click Edit .
   > {#viewing_and_editing_a_user_editing_user1}

6. To edit the user's name, click the pencil icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-edit.svg/jcr:content/renditions/original) ) by the user's name.

7. Enter the first and last name of the user, and click Save. A *Saved* status message appears.

8. To edit the user's job title, click the pencil icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-edit.svg/jcr:content/renditions/original) ) in the Additional information segment of the window.

9. Enter the user's job title in the **Job title** field, and click Save. A *Saved* status message appears.

Enable, Disable, and Delete a User {#disabling_a_user}
======================================================

Follow these steps to enable, disable, or delete a user:

1. From the Settings tab, click User management. Ensure that you are viewing the Users tab, rather than the Roles \& Permissions tab.
2. To enable a user, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column of the user's row, and follow these steps:
   1. Select a user with an Inactive Status, and click Enable.
   2. Click Enable in the *Enable user?* message. The users status changes from Inactive to Active.
      {#disabling_a_user_substeps_hsw_pyf_w3c}
3. To disable a user, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column of the user's row, and follow these steps:
   1. Select a user with an Active Status, and click Disable.
   2. Click Disable in the *Disable user?* message. The user's Status changes from Active to Inactive.
      {#disabling_a_user_substeps_f3h_vyf_w3c}
4. To delete a user, click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column of the user's row, and follow these steps:
   1. Click Delete.
   2. Click Delete in the *Delete user?* message. A verification message appears, and the user is no longer viewable.
      {#disabling_a_user_substeps_mrg_bzf_w3c}

Integrations {#technical}
=========================

The Integrations module enables you to create and manage your REST API security keys, such as the shared secret and certificate key types. This section explains how to complete these tasks:

* Viewing the details of existing API keys
* Copying keys
* Searching for a specific key
* Filtering keys by type or status
* Downloading keys
* Deleting keys
* Generating new keys
  {#technical_ul_unn_jrt_w3c}

View REST Keys {#viewing_rest_keys}
===================================

Follow these steps to view existing REST API keys:

1. From the Settings tab, click Integrations.
2. To view a specific key, click the row containing it.
3. To copy the Key ID, click the **Copy** button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-copy.svg/jcr:content/renditions/original) ). A *Key ID copied to clipboard* verification message appears.

Search REST Keys {#searching_rest_keys}
=======================================

Follow these steps to search for a specific REST API key:

1. From the Settings tab, click Integrations.

2. Select the **Search keys** text field.

3. Enter a Key ID. The entered key appears.

   #### ADDITIONAL INFORMATION

No input type other than an API Key ID produces search results.

Filter REST Keys {#filtering_rest_keys}
=======================================

Follow these steps to filter the displayed REST API keys:

1. From the Settings tab, click Integrations.

2. To filter REST keys by type, click the Key Type: drop-down menu. Follow one or both of these options:

   #### ADDITIONAL INFORMATION

   * To filter the keys by REST - Shared Secret, check the box next to this option.
   * To filter the keys by REST - Certificate, check the box next to this option
3. > When filtering keys by the below variables, ensure that the Select all box is not checked.
   > To filter REST keys by status, click the Status: drop-down menu. Follow one or both of these options:

   #### ADDITIONAL INFORMATION

   * To filter the keys by Active status, check the box next to this option.

* To filter the keys by Expired status, check the box next to this option.

Download Keys {#downloading_keys}
=================================

Follow these steps to download a key:

1. From the Settings tab, click Integrations.
2. Click the row containing the key you choose to download.
3. In the Key details pane, click the Download key button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-download.svg/jcr:content/renditions/original) ). A download result prompt or confirmation message appears in your browser, showing the key downloaded as a *.txt* file.

Delete Keys {#deleting_keys}
============================

Follow these steps to delete a key:

1. From the Settings tab, click Integrations.
2. To delete a key, follow one of these the methods, and then proceed to **Step 3**.
   1. Click the row containing the key you choose to delete, and when the Key details pane displays, click the Delete key button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-delete-row.svg/jcr:content/renditions/original) ).
   2. Click the three-dot menu icon ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-default.svg/jcr:content/renditions/original) ) in the Actions column for the key, and click Delete.
      {#deleting_keys_substeps_q3g_ms5_w3c}
3. At the confirmation prompt, click Delete. A *Key deleted successfully* verification message will appear.

Generate REST API Keys {#generating_rest_api_keys}
==================================================

This section describes how to generate new keys of both the Certificate and Shared secret key types.  
REST API security keys enable you to securely communicate when sending and receiving REST API messages.  
The REST API supports these two types of security keys:

* **Certificates** for using JSON Web Token authentication.
* **Shared secret (key pair)** for using HTTP signature authentication.
  {#generating_rest_api_keys_ul_zxv_d4p_x3c}  
  You can create these keys through the Integrations section of Settings. You can also submit your own public PEM-formatted certificate to use as your security key.

> REST API keys expire after 3 years.  
> Treat your security keys as you would any secure password. If you use both test and production environments, you must use a separate key for each.

Create a Shared Secret {#creating_a_shared_secret}
==================================================

Follow these steps to generate a new Shared Secret:

1. From the Settings tab, click Integrations.

2. Click the Create Key button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-add2.svg/jcr:content/renditions/original) ).

3. Select the key type Shared Secret, and click Generate key.

4. To retain the Shared Secret key generated, perform one or all of the following steps:

   #### ADDITIONAL INFORMATION

   * (Optional) When the *Key created successfully* page opens, you can copy the *Key ID* or the *Shared secret* by clicking the Copy button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-copy.svg/jcr:content/renditions/original) ) next to each.
   * (Optional) To download the generated key, click the Download button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-download.svg/jcr:content/renditions/original) ).
   * (Optional) To generate another key, click Generate another key.

   #### ADDITIONAL INFORMATION

You must save or record the *Key ID* and *Shared secret* strings before closing the *Key created successfully* dialog box. No key information can be recovered. If you lose the key information, you must create a new key.

Create a Certificate {#creating_a_certificate}
==============================================

Follow these steps to generate a new Certificate:

1. From the Settings tab, click Integrations.

2. Click the Create Key button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-add2.svg/jcr:content/renditions/original) ).

3. Select the key type Certificate, and click Generate key.

4. Click the Download button ( ![](/content/dam/documentation/cybs/en-us/common/images/ebc/ebc-bttn-download.svg/jcr:content/renditions/original) ).

5. When the *Protect your key file with a password* dialog box appears, create a password.

   #### ADDITIONAL INFORMATION

   > Your password must be 12-25 characters, and it cannot contain your username or organizationID. It must include both uppercase and lowercase letters, at least one number, and at least one of the following special characters: ().-_#,;/@$:\&!?%. No other special characters will be accepted.

6. Click Download key. The *.p12* file downloads to your system. If prompted by your system, approve or select the download location.

7. Click the downloaded file to initiate the key generation process.

8. When prompted to either save or open the file, select **Open**, and follow the prompts to create and activate a new security key.

9. (Optional) Return to the *Key created successfully* prompt. Select the Public PEM formatted certificate text field, and provide the Public PEM formatted certificate information.

   #### ADDITIONAL INFORMATION

If no Public PEM formatted certificate information is provided, a public-private key pair is generated in your browser and secured in a *.p12* file.
