On This Page
About This Guide
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:AnImportantstatement contains information essential to successfully completing a task or learning a concept.
Recent Revisions to This Document
26.04.1
- Added how to accept or reject transactions that are held for review.
- Added how to manage recurring payments, such as subscriptions and plans.
- See Recurring Billing.
26.03.1
- Initial version.
Payment Center
The Merchant Experience enables you to take payments and manage transactions that
represent payments.
The following options are available in the Payment Center:
- Charge a card with basic payment information.
- Charge a card to pay for a specific item, with optional freight and duty added.
- Find information about your transactions.
- Search for Pay by Link
- Search for Invoices
- Create, edit, suspend, reactivate, cancel, and restart subscriptions.
- Queue an Authorize Only transaction for settlement.
- Cancel a payment before it settles.
- Refund part or all of the amount of the transaction back to the customer.
Take a Quick Payment
Follow these steps to accept a payment without itemized details.
- ClickPayment Center.
- ClickTake a Payment.
- Select a curency and enter the amount of the payment.
- Enter a transaction description if desired.
- CheckAuthorize onlyif you want to manually capture the payment for settlement at a later time.
- Search for a customer if you want to include the information for an existing customer, or clickAdd new customerand enter the customer name and address if you want to add a new customer.
- 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. - CheckAdd billing and shipping informationif you did not include a customer previously and if you want to include the billing and shipping information with this payment.
- Enter the first and last name.
- Begin typing the street address.
Step Result
Suggested street addresses appear. Click the address for the customer when it appears. - CheckUse a different shipping addressif 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. - ClickEditif 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. ClickSaveto save the tax jurisdiction and tax rate or rates. - ClickCharge.
- ClickTake new paymentif you want to take another payment, or clickTransaction detailsto view the transaction details.
RESULT
The payment is submitted. If you did not check
Authorize
only
, the transaction settles automatically.Take an Itemized Sale
Follow these steps to accept a payment with itemized details.
- ClickPayment Center.
- ClickTake a Payment.
- ClickItemized sale
- Select a currency.
- Enter a transaction description if desired.
- CheckAuthorize onlyif you want to capture the payment manually for settlement at a later time.
- ClickAdd item or service.
- Enter an item ID number, item name, quantity, and unit price.
- ClickAdd discountif 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. - ClickEditif 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. ClickSaveto save the tax jurisdiction and tax rate or rates. - ClickSave item.
- Repeat the previous step if you have more items or services to add.
- Search for a customer if you want to include the information for an existing customer, or clickAdd new customerand enter the customer name and address if you want to add a new customer.
- 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. - CheckAdd billing and shipping informationif you did not include a customer previously and if you want to include the billing and shipping information with this payment.
- Enter the first and last name.
- Begin typing the street address.
Step Result
Suggested street addresses appear. Click the address for the customer when it appears. - CheckUse a different shipping addressif 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. - ClickAdd freight/shippingif freight or shipping applies, and enter the freight/shipping amount.
ADDITIONAL INFORMATION
Freight and shipping do not apply for services. - ClickAdd dutyif duty applies, and enter the duty amount.
ADDITIONAL INFORMATION
Duty does not apply for services. - ClickCharge.
- ClickTake new paymentif you want to take another payment, or clickTransaction detailsto view the transaction details.
RESULT
The payment is submitted. If you did not check
Authorize
only
, the transaction settles automatically.Transaction Summary and 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
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
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
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
Follow these steps to capture an authorization for settlement:
- ClickPayment Center.
- UnderType, selectAuthorization.
- Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
- Clickand selectCapture payment.
RESULT
The authorization is captured for settlement.
Void a Transaction
Follow these steps to void a transaction:
- ClickPayment Center.
- UnderStatus, selectPending.
- Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
- Clickand selectVoid transaction.
- Confirm that you want to void this transaction and clickVoid transaction, or clickCancelif 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
Follow these steps to refund a transaction:
- ClickPayment Center.
- Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
- Clickand selectRefund transaction.
- Confirm that you want to email a receipt to the customer. UncheckEmail transaction receipt to customerif you do not want to send an email receipt. Update the customer's email if necessary.
- 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. - Enter a reason for the refund if desired.
- ClickSubmit refund, or clickCancelif you decide not to refund the transaction.
RESULT
The transaction is refunded.
Accepting or Rejecting a Transaction Held for Review
Follow these steps to accept or reject a transaction that is held for review:
- ClickPayment Center.
- UnderStatus, selectHeld for review.
- Use the search option to search by customer name, card number, or amount. Or, use the pagination controls to manually search for the transaction.
- Clickand selectAccept transactionif you want to process the transaction as usual, or selectReject transactionif you want to prevent the transaction from processing.
RESULT
The transaction is accepted or rejected.
Recurring Billing
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
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
Follow these steps to create a plan:
- Sign in to the dashboard.
- Click the Plan name text box, and type the plan name.
- (Optional) Click the Plan description text box, and type a plan description.
- From the Amount drop-down menu, choose a currency.
- From the Frequency drop-down menu choose the billing frequency. If you choose a custom frequency, follow Stepsaandb. If you do not choose a custom frequency, skip to Step 6.
- Set the billing frequency. Click the Repeat every text box, and enter a repetition number.
- From the drop-down menu, choose the type of time period.
- From the Billing cycles drop-down menu, chooseIndefiniteorSet number of billing cycles. If you chooseSet number of billing cycles, follow Stepa. If you chooseIndefinite, skip to the optional Step 7.
- Click the Billing Cycles text box, and type the billing cycle number.
- (Optional) To include an initial setup fee, click the Setup fee text box, and type the initial setup fee.
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.
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
You can manage a plan by creating subscriptions, activating or deactivating a plan,
and deleting a plan. Follow these steps to manage plans:
- To create a new subscription in an existing plan, click the three-dot menu icon (
) in the Actions column. Choose
Create Subscriptionfrom the drop-down menu. For more information about creating subscriptions see the Create Subscription section. - To activate a plan, choose the inactive plan you want to activate, and click the three-dot menu icon (
) in the Actions column. Choose
Activate Planfrom the drop-down menu. - To deactivate a plan, click the three-dot menu icon (
) in the Actions column, and choose
Deactivate Plan. ClickDeactivate Planin 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. - To delete a plan, click the three-dot menu icon (
) in the Actions column, and click
Delete Plan. In the confirmation box, clickDelete Plan.ADDITIONAL INFORMATION
You cannot delete a plan if it is used in one or more subscriptions. If you clickDelete Plan, theThis plan can't be deletedmessage displays.
Create a Subscription
Follow these steps to create a subscription:
- SelectPayment Center, click the plus symbol menu icon (
) in the dashboard. Select
Create Subscription. - 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.
- To add a new customer, select the field under Customer. ChooseAdd new customerat the bottom of the drop-down menu. The Add customer window appears.
- Select the displayed fields individually, and enter the information for the customer.
- Select theBilling addressfield. ClickAdd new addressat the bottom of the list, and search for the address or enter it manually. When the address is entered, clickSave.
- (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.
- (Optional) You can enter the Customer reference ID and/or Phone information for the customer in the fields beneath Additional details.
- 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.
- Under Plan, click the drop-down menu, and choose the plan to which you are attaching the subscription.
- (Optional) To review the details of the selected plan, clickView plan details. This displays the plan's cost, billing frequency, billing duration, and other information.
- Select the date on which the subscription starts.
- ClickSave Subscription.
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:
- To view all registered subscriptions, selectPayment Center, and selectSubscriptions.
- Select a subscription to view its details.
- To suspend a subscription, clickSuspend subscription. When the confirmation window appears, clickSuspend Subscription.
- To reactivate a subscription, select a suspended account. ClickReactivate subscription. When the confirmation window appears, clickReactivate Subscription.
- To review the Payment history for the last 12 months of a subscription's activity, clickShow moreunder Payment history within Subscription details.
- If a subscription has a Delinquent status, you can click the lowercaseinext to the subscription's status to view why it is delinquent.
- To view the Plan details associated with a subscription, select the associated[Plan name]next to Plan within Subscription details.
- To review an individual transaction, selectTransactionsunder Payment Center.
Edit a 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.
- To begin editing a subscription, clickPayment Centerand selectSubscriptions.
- Select the subscription you wish to edit.
- ClickEdit subscription.
- 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. - If the subscription has already processed a payment, you can manually recreate it. ClickCancel and create new subscriptionunder View plan details, and clickCancel Subscriptionto cancel the subscription.
Manage a 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:
- To begin managing a subscription, navigate to the Payment Center, and clickSubscriptions.
- To view a description of plans and how they work together, clickHow 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. - Within the subscriptions list, choose a subscription to manage.
- Under Actions, click the three-dot menu icon (
) 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.
- To filter subscriptions based upon Frequency, click theFrequencydrop-down menu, and choose the desired filter(s).
- To filter subscriptions based upon Status, click theStatusdrop-down menu, and choose the desired filter(s).
- To suspend an Active status subscription, click the three-dot menu icon (
) drop-down for the subscription, and select
Suspend subscription. When the confirmation window appears, clickSuspend Subscription. - To cancel a subscription, click the three-dot menu icon (
) drop-down for the subscription, and select
Cancel subscription. When the confirmation window appears, clickCancel Subscription.
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
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
Follow these steps to edit your profile name:
- To navigate to your profile information, either click the tab that contains your profile name and an arrow symbol (
), or click the
Settingstab and selectMy Profile. - To edit your profile name, click the pencil icon (
) next to your profile name.
- The first and last name input fields appear. Enter your first and last name.
- ClickSave. When the merchant account has been succesffully created, a save validation message appears.
Change Profile Password
Follow these steps to change your profile's password:
- To navigate to your profile information, click the tab that contains your profile name and an arrow symbol (
), or click the
Settingstab and selectMy Profile. - To change your password, clickChange password.
- The Change password page opens.
- Click theCurrent passwordfield, and enter your current password.
- Click theNew passwordfield, and enter your new password.
- Click theConfirm new passwordfield, and re-enter the new password.
ADDITIONAL INFORMATION
Your new password must meet the requirements listed underPassword muston the Change password page. - ClickSave. A save validation message appears.
Update Profile Email Address
Follow these steps to update your profile's email address:
- To navigate to your profile information, either click the tab that contains your profile name and an arrow symbol (
), or click the
Settingstab and selectMy Profile. - To update your email information, click the pencil icon (
) next to your email address.
- The Update email address page appears.
- Click theNew email addressfield, and enter your new email address.
- Click theConfirm new email addressfield, and re-enter the new email address.
- Click theEnter your password field, and enter your profile password.
- ClickSave.
- 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 theResend codelink. - ClickVerify code. A save validation message appears.
ADDITIONAL INFORMATION
If you do not successfully complete the verification process, an orangeNot verifiedtag appears under your email address. When the process is completed successfully, a greenVerifiedtag appears instead.
Update Profile Mobile Number
Follow these steps to update your mobile phone number:
- To navigate to your profile information, click the tab that contains your profile name and an arrow symbol (
), or click the
Settingstab and selectMy Profile. - To update your mobile phone number, click the pencil icon (
) next to your phone number.
- The update mobile number page appears.
- Click theNew mobile numberfield, and enter your new mobile number.
- Click theConfirm new mobile numberfield, and enter the same mobile number.
- Click theEnter your passwordfield, and enter your profile's password.
- ClickNext.
- 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.
- ClickSubmit. A save validation message appears.
ADDITIONAL INFORMATION
If you do not successfully complete the verification process, aNot verifiedtag appears under your mobile number. When the process is completed successfully, a Verified tag appears instead.
Edit Profile Time Zone
Follow these steps to update your time zone preferences:
- To navigate to your profile information, click the tab that contains your profile name and an arrow symbol (
), or click the
Settingstab and selectMy Profile. - In the Preferences section, click the Time zone drop-down menu.
- Choose a time zone.
- 3. ClickSave. A save validation message appears.
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
Follow these steps to edit your business contact information:
- From the Settings tab, clickMy business.
- On the My business page, clickEdit.
- To change your business phone number, perform the following actions:
- Click the country code drop-down menu, and choose a code.
- Select thePhone numberfield, and enter the phone number.
- ClickSave. A save validation message appears.
- To change your business email address, perform the following actions:
- Select theEmail addresstext field, and enter the email address.
- ClickSave. A save validation message appears.
- To change the business website, perform the following actions:
- Select theWebsitetext field, and enter the website URL.
- ClickSave. A save validation message appears.
Upload a Logo
Follow these steps to upload or change the logo for your business:
- From the Settings tab, clickMy business.
- In the Upload logo section, click theDrag and drop your logo or click to browsebox, 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. - ClickSave. A save verification message appears.
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
Follow these steps to edit your payment preferences:
- From the settings tab, clickPayments.
- Click theDefault currencydrop-down menu, and chooseUSDorCAD.
- ClickSave. A save verification message appears.
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
Follow these steps to add a user:
- From the Settings tab, clickUser management.
- ClickAdd user.
- Enter the name, username, email address, and phone number for each user.
- 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. - (Optional) In theJob titlefield, and enter the user's job title.
- ClickAdd 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
Follow these steps to view or edit a user:
- From the Settings tab, clickUser management.
- From the Users tab of the User Management window, click on a username.
- (Optional) To search for a specific user, click theSearch user by name or emailfield, and enter the user's name or email address.
- (Optional) To organize the table based upon a specific column value, click a column title. You can filter the table order by clickingDate created,Username,Name,Role,Email, orStatus. Click a value once for ascending, twice for descending, and a third time to reset the value to its default order.
- Click the row containing the user's information. The User profile page appears for that user.
ADDITIONAL INFORMATION
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 (), and click
Edit. - To edit the user's name, click the pencil icon (
) by the user's name.
- Enter the first and last name of the user, and clickSave. ASavedstatus message appears.
- To edit the user's job title, click the pencil icon (
) in the Additional information segment of the window.
- Enter the user's job title in theJob titlefield, and clickSave. ASavedstatus message appears.
Enable, Disable, and Delete a User
Follow these steps to enable, disable, or delete a user:
- From the Settings tab, clickUser management. Ensure that you are viewing the Users tab, rather than the Roles & Permissions tab.
- To enable a user, click the three-dot menu icon (
) in the Actions column of the user's row, and follow these steps:
- Select a user with an Inactive Status, and clickEnable.
- ClickEnablein theEnable user?message. The users status changes from Inactive to Active.
- To disable a user, click the three-dot menu icon (
) in the Actions column of the user's row, and follow these steps:
- Select a user with an Active Status, and clickDisable.
- ClickDisablein theDisable user?message. The user's Status changes from Active to Inactive.
- To delete a user, click the three-dot menu icon (
) in the Actions column of the user's row, and follow these steps:
- ClickDelete.
- ClickDeletein theDelete user?message. A verification message appears, and the user is no longer viewable.
Integrations
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
View REST Keys
Follow these steps to view existing REST API keys:
- From the Settings tab, clickIntegrations.
- To view a specific key, click the row containing it.
- To copy the Key ID, click theCopybutton (
). A
Key ID copied to clipboardverification message appears.
Search REST Keys
Follow these steps to search for a specific REST API key:
- From the Settings tab, clickIntegrations.
- Select theSearch keystext field.
- 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
Follow these steps to filter the displayed REST API keys:
- From the Settings tab, clickIntegrations.
- 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
- 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
Follow these steps to download a key:
- From the Settings tab, clickIntegrations.
- Click the row containing the key you choose to download.
- In the Key details pane, click theDownload keybutton (
). A download result prompt or confirmation message appears in your browser, showing the key downloaded as a
.txtfile.
Delete Keys
Follow these steps to delete a key:
- From the Settings tab, clickIntegrations.
- To delete a key, follow one of these the methods, and then proceed toStep 3.
- Click the row containing the key you choose to delete, and when the Key details pane displays, click theDelete keybutton (
).
- Click the three-dot menu icon (
) in the Actions column for the key, and click
Delete.
- At the confirmation prompt, clickDelete. AKey deleted successfullyverification message will appear.
Generate 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:
- Certificatesfor using JSON Web Token authentication.
- Shared secret (key pair)for using HTTP signature authentication.
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 Certificate
Follow these steps to generate a new Certificate:
- From the Settings tab, clickIntegrations.
- Click theCreate Keybutton (
).
- Select the key type Certificate, and clickGenerate key.
- Click theDownloadbutton (
).
- When theProtect your key file with a passworddialog 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. - ClickDownload key. The.p12file downloads to your system. If prompted by your system, approve or select the download location.
- Click the downloaded file to initiate the key generation process.
- When prompted to either save or open the file, selectOpen, and follow the prompts to create and activate a new security key.
- (Optional) Return to theKey created successfullyprompt. 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.p12file.