On This Page
REST API | Visa Platform Connect
Product Boarding Template Reference
Use this information as a guide to configure the boarding templates.
We update this reference as existing templates get updated and new templates are
added.
Account Updater
Select configuration options for each of the following fields:
Field | Option 1 | Option 2 | Option 3 | Option 4 | Option 5 | Option 6 |
---|---|---|---|---|---|---|
Visa/Mastercard Mode | Pan Upload | Token API | Monthly Harvest | |||
AMEX Mode | Token API | Monthly Harvest | ||||
Request Updates from AMEX | Yes | No | ||||
AMEX SE Number | INPUT SE # | |||||
AMEX Subscriber ID | INPUT ID # | |||||
Request Updates from Mastercard | Yes | No | ||||
Mastercard ICA Number | 10426 | 10427 | 1835 | 1836 | 4845 | 8773 |
Mastercard Merchant ID | INPUT MID # | |||||
Request Updates from Visa | Yes | No | ||||
VISA Segment ID | 0040 | 0043 | 0044 | 0048 | 0057 | 0088 |
VISA Merchant ID | INPUT Visa MID # |
Card Processing
Create a card-processing template for each payment processor you use. Each
card-processing template is specific to a single payment processor. Apply the
appropriate template when you are boarding new merchants.
Configuration Steps
- Log in to the Business Center.
- Open the Portfolio Management menu in the left navigation bar, and then selectTemplate Management.
- ClickAdd New Template.
- SelectCard Processingfrom the drop-down list.
- Enter a unique name for the new card-processing template, and then clickNext.
- Select the type of card processing:Card Present,Card Not Present, orBoth.
- Click in theProcessorfield, and then choose the payment processor name.
- If an Acceptance Type field appears, click in the field, and then choose the acceptance type.
- In the processor tab (labeled with the name of the processor you selected), configure the required and optional fields available for the selected payment processor.
- In the Common Settings tab, you can configure fields that are common for the merchant but that could potentially be used across multiple payment processors.
Processor-Specific Fields
The following paragraphs describe some of the processor-specific fields that are
frequently configured in a card-processing template. For more information about these
and other fields in the template, see the
API Field Reference Guide
.- Accepted Currencies
- Select all of the currencies that the merchant accepts. The currencies listed in this field depend on the payment processor selected.As an example, if you are creating a card-processing template for the TSYS/Vital processor, the list of accepted currencies is as follows:
- CAD (Canadian Dollar)
- USD (US Dollar)
For more information about currency codes, seeISO Standard Currency Codes. - Accepted Payment Types
- Select all of the card types that the merchant accepts. The card types listed in this field depend on the payment processor selected.Depending on your payment processor, these are some of the card types you can expect to see listed:
- Visa
- Mastercard
- American Express
- Diners Club
For more information about the specific card types that your processor supports, log in to the Business Center and go toTemplate Management for Card Processing. - Batch Group
- The Batch Group groups all of the capture (bill and credit) requests into a batch bound for your payment processor.Choose the batch group for processing capture requests.The name of a batch group identifies the time of day that capture requests are grouped into a batch and sent to your payment processor. The last two digits of the batch group name identify the hour (in 24-hour time) of the processor cutoff time for that batch group.As an example, if you are creating a card processing template for the American Express Direct processor, the list of batch group names you can select includes the following:
- amexdirect_2 (processor cutoff time is 2:00 a.m. PST daily)
- amexdirect_17 (processor cutoff time is 5:00 p.m. PST daily)
- amexdirect_21 (processor cutoff time is 9:00 p.m. PST daily)
IMPORTANTProcessor cutoff times identified in the batch group names are in Pacific Standard Time (PST). - Merchant ID
- Enter the merchant's acquirer processing ID assigned by the acquiring bank.
- Note that it is unlikely that you would specify this field in a card-processing template. Typically, the merchant ID is merchant specific. Also, many merchants have more than one merchant ID to support processing in multiple currencies or to process both card present (in store) transactions and card-not-present (e-commerce) transactions.
- Terminal ID
- Enter the terminal ID assigned by the acquirer or the processor. This value should not be overridden by any other party.
- Enter the merchant's processing terminal ID assigned by the acquiring bank or payment processor.
- Note that it is unlikely that you would specify this field in a card-processing template. Typically, the terminal ID is merchant specific. Also, many merchants have more than one terminal ID to support processing in multiple currencies or to process both card-present (in store) transactions and card-not-present (e-commerce) transactions.
Fraud Management Essentials
On the General Settings page, select options for each of the following:
Section Name | Field Name | Available Options / Details |
---|---|---|
Payment Processing | Settlement | Disable Settlement Enable Settlement Enable with settlement selected by default |
Decision Reject | Authorization Reversal | Disable authorization reversal option Enable authorization reversal option Enable with authorization reversal option selected by default |
Local Currency | Local Currency | Select the local currency from the list. |
On the Rule Configuration page, configure the options for each of the following:
Tab Name | Field Name | Available Options / Details |
---|---|---|
Score Threshold | Score Threshold | Score between 50-69 Score between 70-94 Score between 95-100 Note: Each threshold has an enable/disable checkbox. Each
score can be adjusted to user specifications. |
Standard Rules | AVS Mismatch | Monitor, Review, Reject, Disable |
Standard Rules | AVS Partial Match | Monitor, Review, Reject, Disable |
Standard Rules | AVS Not Verifiable | Monitor, Review, Reject, Disable |
Standard Rules | CVV Mismatch | Monitor, Review, Reject, Disable |
Standard Rules | CVV Not Verifiable | Monitor, Review, Reject, Disable |
Standard Rules | Invalid Address | Monitor, Review, Reject, Disable |
Standard Rules | Billing-Shipping Mismatch | Monitor, Review, Reject, Disable |
Standard Rules | Billing-IP Mismatch | Monitor, Review, Reject, Disable |
Standard Rules | Shipping-IP Country Mismatch | Monitor, Review, Reject, Disable |
Regional & Country IP Address
Rules | Decision | Review, Reject, Monitor |
Regional & Country IP Address
Rules | Region | Regions include: Asia, Europe, Africa,
Oceania, Central America/Caribbean, Arctic/Antarctica, South America,
North America, Middle East |
Regional & Country IP Address
Rules | Countries | Check the All box for all countries
in a region or select individually listed countries. |
Velocity Rules | Decision | Monitor, Review, Reject |
Velocity Rules | Field | Email, Total count, Device, Shipping
Address, Account Number, IP Address |
Velocity Rules | Value | Input Value for Transactions in
Field |
Velocity Rules | Time Range | Range of time the rule is valid
for. |
Threshold Rules | Decision | Monitor, Review, Reject, Disable |
Threshold Rules | Rule - Min Order Amount | Order Amount minimum amount |
Threshold Rules | Value | Input order dollar amount |
Threshold Rules | Decision | Monitor, Review, Reject, Disable |
Threshold Rules | Rule - Max Order Amount | Order Amount Maximum amount |
Threshold Rules | Value | Input order dollar amount |
Payer Authentication
A payer authentication template specifies the payer authentication services that a
merchant account will accept. To specify a payer authentication service, enter the
acquirer ID in the associated field. This template supports the following payer
authentication services:
- Visa Secure with EMV
- The Visa card type uses Visa Secure with EMV as the authentication service. The acquirer ID is a text string that consists of 6 to 20 digits and starts with the number 4.
- Mastercard Identity Check
- The Mastercard card type uses Mastercard Identity Check as the authentication service. The acquirer ID is a text string that consists of 6 to 20 digits and starts with the number 5 or 2.
- American Express SafeKey
- The American Express card type uses American Express SafeKey as the authentication service. The acquirer ID is a text string that consists of 11 to 20 digits and starts with the number 1.
- Cartes Bancaires Fast'R
- The Cartes Bancaires card type uses Fast’R as the authentication service. The acquirer ID is a text string that consists of 6 to 20 digits and starts with the number 4, 5, or 2.
- Discover / Diners Club ProtectBuy
- The Discover / Diners Club card type uses ProtectBuy as the authentication service. The acquirer ID is a text string that consists of 6 to 20 digits and starts with the number 3 or 6.
- Elo Compra Segura
- The Elo card type uses Elo Compra Segura as the authentication service. The acquirer ID is a text string that consists of 4 digits. The acquirer ID is a text string that consists of 8 digits and starts with the number 1.
- JCB J/Secure
- The JCB card type uses J/Secure as the authentication service.
- The JCB card type adds another layer of security by asking the card user to enter a special JCB J/Secure password. To include the JCB card type in the template, you must also specify a JCB J/Secure password.
- UnionPay 3D Secure
- 3D Secure is a protocol designed to be an additional security layer for online credit and debit card transactions. The acquirer ID is a text string that consists of 6 to 20 digits and begins with the number 4, 5, 2, or 6.
Secure Acceptance
Step 1. Complete the Template Details Page.
This information gets populated in the
Secure Acceptance
- General Settings tab.Fields | Option 1 | Option 2 | Option 3 |
---|---|---|---|
Integration Methods | Select Hosted Payments Page or Checkout API | Input the Company Name, Contact Information
(Name, Email, Phone). | |
Added Value Services | Payment Tokenization | Decision Manager Select Verbose Data | Decision Manager Select the Generate Fingerprint Device |
Step 2. Make field selections in the Configuration page:
Configuration TAB | Option 1 | Option 2 | Option 3 | Option 4 | Option 5 | Option 6 |
---|---|---|---|---|---|---|
General Settings | Profile Information | Integration Methods | Contact Information | Added Value Services | ||
Payment Settings | Card Type Select Card Type(s). Search for Card Types using the
button. | Payer Authentication 3DS Version
| Automatic Authorization Reversal Select Fails AVS Check or Fails CVN Check . | Echeck Select Enable Echeck
Payments . | CVN Select CVN Display , CVN Required and/or Payer
Authentication . | Currencies Select accepted currencies. |
Payment
Form | Payment Form Flow Select Multi-Step or Single Page . | Checkout Steps Input customer Billing, Shipping, and Payment Information. | Payment Information Select sensitive fields to mask. | Order Review Select to Display or to Edit Billing, Shipping, and Payment
Information. | ||
Notifications | Merchant Notifications Input the Merchant's POST URL and Email. | Customer Notifications Select to send an Email Receipt to the Customer. | ||||
Customer Response | Transaction Response Page Select the Host. | Transaction Response Message Set the Decline Limit. | Custom Cancel Response Page Select the Host. | Custom Redirect After Checkout Enter the URL. | ||
Branding | Header Content Select the Display Header, color, logo, and placement. | Main Body Select Colors, Type Face. | Total Amount Select the Colors. | Progress Bar Select the Colors. | Pay/Finish Button Select the Colors. | Footer Content Select Display Footer and add the image, color, and placement. |
Token Management Service
Select payment method and service configuration options for each of the following
fields:
Fields | Option 1 | Option 2 | Option 3 |
---|---|---|---|
Supported Payment Methods | Card | Echeck | |
Tokens: Token Types | Customers | Payment Instrument | Instrument Identifier |
Click checkbox; then select from the following formats: - 32-character Hex - 22 Digits - 19 Digits Luhn Check Passing - 16 Digits Luhn Check Passing | Click checkbox; then select from the following formats: - 32-character Hex - 22 Digits - 19 Digits Luhn Check Passing - 16 Digits Luhn Check Passing | Format - Card, echeck (ACH) Formats default to 32 Character Hex. | |
Card Number Masking Format | Select either First 6 digits OR Last 4
returned clear | Select either First 6 digits OR Last 4
returned clear | |
Enable Network Tokenization
Services | VISA (Enable/Disable*) Note: Disabling this option requires the following information
for authorization:- TRID, Client ID - API KEY, Post Back API Key - Shared Secret, Post Back Shared Secret | Mastercard (Required) Note: Disabling this option requires the following information
for authorization:- Enable Transactions with Mastercard Network Tokens - Enter TRID | |
Push Notification Webhook | Add Test URL if using Webhook for push
notifications. | Push notifications sent when there are
updates to tokenized cards, (new card numbers, new expiration date,
account closures). |
Virtual Terminal
Select configuration options for each of the following fields:
Fields | Option 1 | Option 2 | Option 3 |
---|---|---|---|
Default Transaction Type | Card Not Present | Card Present | |
Acceptance Type | Card Not Present | Card Present | Both |
Merchants Edit Template? | YES | NO | |
Add Check Related Fields? | YES | NO Selecting No does not disable
echeck transactions. | |
Add Merchant Defined Data Fields? | YES | NO | |
Add EMV Fields? | YES | NO | |
Add Level 3 Fields? | YES | NO | |
Add Service Fee Fields? | YES | NO |
Echeck
Make the following field selections in the echecks configuration page:
Field | Value or Option |
---|---|
Echeck Processor | Bofa ACH |
Batch Group | Select a batch group. Batch time is
identified by the last two digits in military time. Example:
<processor>_16 means the cut-off time is 4:00 p.m. PST.
Convert the time to your local time as needed. |
Auto Set to Completed State | Select Yes to automatically update
transactions to "Completed" status a number of days after the
transaction is processed. |
Company ID | Merchant's ID assigned by the acquiring
bank. |
ACH Entry Description | Merchant-defined description. Example:
Payroll, Gas Bill, Insurance Premium. |
Gift Cards
Make the following field selections in the Gift Cards configuration page:
Field | Value or Option |
---|---|
Gift Card MID | The Valuelink Gift card assigned merchant
number which includes the plan, root, merchant location, and check
digit. |
Merchant SIC Code | Merchant Category Code. |
Merchant Store ID | Store ID number. |
Enable PIN encryption? | Select Yes to encrypt the PIN before
sending it to the processor. |
Enable Merchant defined Transaction
Reference Number? | Select Yes to allow the merchant to
define the transaction reference number. Otherwise, it is
auto-generated. |