Versions Compared

Old Version 2

changes.mady.by.user Miles Graves

Saved on

compared with

New Version Current

changes.mady.by.user Jennifer J. Black

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This topic describes the following pages:

  • Subscription Details

  • Payment Token

The Subscription Details page contains information about any recurring payment made as part of a subscription through your merchant. Subscription Details can be accessed for transactions listed on your Recurring Payments table.

Navigate to a Access the Subscription Details page by clicking on any information in a Recurring Payments table row.

...

Expand
titleClick here to view features of the Subscription Details page.

Subscription Details Banner

The banner at the top of the Subscription Details page includes the following information about a recurring payment:

Subscription Details Banner Item

Description

Customer

The name of the customer who pays the subscription charges.

Payments Made

The number of previous payments made through the subscription and their dollar amount.

Payments Remaining

The number of remaining payments for the subscription and their dollar amount.

Payments Failed

The number of missed payments and their dollar amount.

Plan Name

The merchant's name for the subscription.

Plan Amount

The recurring cost in dollars for the subscription.

Subscription Amount

The total dollar amount of the subscription.

Merchant

The name of the merchant associated with the subscription.

Subscription Information Box

The lower half of the Subscription Details page contains the Subscription Information Box, which contains four tabs on the left hand side of the box. The tabs consist of information related to aspects of the subscription, the customer, and the merchant. The following sections of this page cover descriptions of the contents of each of the four tabs:

Details Tab

The Details tab includes the following details for a specific subscription:

Details Tab Item Name

Description

ID

The subscription identification number created by Payrix.

Created

The date that the subscription was created.

Plan ID

The plan identification number created by Payrix.

Merchant ID

The merchant identification number created by Payrix.

Start

The start date for the subscription.

Finish

The date that the subscription will end.

Tax

The dollar amount of tax charged with the subscription.

Max. Consecutive Failures

The maximum number of attempts made to charge the saved payment method for the subscription if the payment method fails or is declined. If the Max. Consecutive Failures limit is reached, the subscription will be canceled.

Consecutive Failures

Number of consecutive failed transactions.

Status

The status of the subscription: Active or Inactive

Transaction Description

Defined by the merchant, and applied to transactions generated as part of the subscription.

Details Tab Actions

The Details tab supports the following actions:

  • Copy and paste information from select fields by clicking the COPY/PASTE icon.

    • Edit any fields

    To edit any field on the Details tab

    by following the steps below

    :

    Step 1:

    1. Click the Edit icon in the top right hand corner of the box.

    Step 2:

    1. Type your editing into the Details field.

    Step 3:

    1. Click the Check Mark icon at the top right hand corner to save or the X icon to revert to the previously saved details.

    Copy and paste information from select fields using the COPY/PASTE icon.

    Tokens Tab

    The Tokens tab displays a table of Payment Tokens associated with a subscription , as well as and an option to add a new payment method. The Payment Tokens table includes the following information in the default view:

    Payment Tokens Table Column Name

    Description

    Token

    The token identification number created by Payrix.

    Expiration

    The expiration date for the token.

    Type

    The type of credit card.

    Number

    The credit card number associated with the token.

    Payment Token Tab Actions

    The Payment Token tab supports the following actions:

    Add

    To add a new payment token

    by following the steps below

    :

    1. Click the ADD PAYMENT button in the top right hand corner.

    2. Add the token ID

    ,

    1. or click CREATE WITH TOKEN to create a payment using customer email and credit card information.

    2. Click ADD to save the new payment

    , or click CANCEL to return to the Token tab

    1. .

    Remove

    To remove a token from the table

    by clicking

    , click the purple TRASH CAN icon to remove the token from the subscription.

    Plan Details Tab

    The Plan Details tab contains the following information about the subscription:

    Plan Details Tab Item Name

    Description

    Plan ID

    The plan identification number created by Payrix.

    Created

    The date that the subscription was created.

    Merchant ID

    The merchant identification number created by Payrix.

    Name

    The merchant’s name for the subscription plan.

    Description

    The type of plan as described by the merchant.

    Amount

    The scheduled subscription payment in dollars.

    Schedule Factor

    The number of times per month that the subscription is billed.

    Schedule

    Monthy, daily, or yearly schedule of payments.

    Status

    The status of the subscription: Active or Inactive

    Transaction Description

    Defined by the merchant and applied to transactions generated as part of the subscription.

    Plan Details Tab Actions

    Copy and paste information from select fields by clicking using the COPY/PASTE icon.

    Transactions Tab

    The Transactions tab contains a table that lists the individual transactions associated with the subscription payment plan. The table shows the following information in the default view:

    Transactions Table Column Name

    Description

    Amount

    The amount in dollars charged for the recurring payment.

    Status

    Indicates whether the transaction was captured as a recurring payment by the merchant.

    Cardholder

    The name of the cardholder.

    Payment

    The credit card brand and the last four digits of the card number.

    Created

    The date and time that the transaction was created.

    Merchant

    The name of the merchant.

    Check boxes

    Tick to select specific transactions, or tick the checkbox in the table header to select all transactions.

    Arrow Icon

    Click on the grey triangle in any row to view additional details for a specific transaction, or click on the grey triangle in the table header to view additional details for all transactions.

    Transactions Tab Actions

    The Transactions tab supports the following actions:

    • View additional information on a specific transaction by clicking any row in the table.

    • Access specific Transaction Details by clicking any information in a row.Issue Refunds

    To issue refunds on certain transactions using the Batch Actions function:

    Step 1:

    1. Select specific transactions from the Transactions table using the Check boxes in the table column on the right hand side.

    Step 2: Navigate to

    1. Access the Batch Actions drop down, select the grey triangle, and click REFUNDS.

    Step 3:

    1. Confirm the refund request in the pop-up window

    , or cancel to go back to the Payments History page

    1. .

    Customize Your Subscription Transaction Table

    ...

    Expand
    titleClick here to view Subscription Transaction Tab columns:

    Transaction Data

    • Amount

    • Cardholder

    • Payment

    • Created

    • TXN ID

    • Zip

    • Currency

    • Company

    • Created by

    • Date Modified

    • Modifier

    • Subscription Type

    • Captured

    • Description

    • Order

    • Tax

    • Approved

    • Refunded

    • Terminal ID

    • Channel

    • First Name

    • Last Name

    • Address

    • City

    • State

    • Country

    • Phone

    • Email

    Entity Data

    • Merchant

    • Entity

    • Custom

    • Entity ID

    • Parameters ID

    • Entity Type

    • Address

    • Entity City

    • Entity State

    • Entity Zip

    • Entity Country

    • Entity Phone

    • Entity Fax

    • Entity Email

    • Entity Website

    • EIN

    • Entity Currency

    • Entity Status

    Division Data

    • Division Name

    User Data

    • Login ID

    Merchant Data

    • Merchant ID

    • Merchant Dba

    • Merchant MCC

    • Merchant Created

    • Merchant Created By

    • Merchant Date Modified

    • Merchant Modified By

    • Merchant Boarded

    • Merchant Last Txn

    • Merchant Date Established

    • Merchant Status

    Related Pages:

    ...

    Recurring Payments

    ...

    Payment Token

    The Payment Token page allows users to view and edit information associated with a payment token linked to a subscription paid to your merchants. A payment token is the cryptographically-generated representation of a payment method that can be safely stored and used to process future transactions.

    To access the Payment Token page:

    1. Access the Recurring Payments page in the left hand navigation panel.

    2. Click any information in a Recurring Payments table row to redirect to the Subscription Details page.

    3. Click the Tokens Tab located in the Subscription Information box, in the lower half of the Subscription Details page.

    4. Click any information in the Tokens table to access the Payment Token page.

    ...

    View of the Payment Token page showing the Payment Token fields.

    Payment Token Features

    Expand
    titleClick here to view features of the Payment Token page.

    The Payment Token page contains an editable form which includes the following information about a payment token:

    Payment Token Field Name

    Description

    ID

    The identification number assigned to the token by Payrix.

    Expiration

    The credit card expiration date.

    Type

    The type of credit card used during the transaction.

    Number

    The credit card number, with the last four digits visible.

    Name

    The name on the credit card.

    Description

    The description associated with the token.

    Custom Description

    A custom description written by the merchant.

    Token

    The tokenized identification number associated with the credit card.

    Payment Token Actions

    To edit information on the Payment Token page:

    1. Click the EDIT icon in the upper right hand corner.

    2. Enter information into the editable fields.

    3. Save your edited information by clicking the CHECK MARK icon in the upper right hand corner, or discard changes and return to the Payment Token page by clicking the X icon.

    Related Pages:

    ...