Menu

Bank Card Details Object

This object is used to describe the various details associated with applying to processing bank card transactions.


Card Brands Requested

These fields will determine what type of card brands are requested.


Credit Brands Requested

Description

Types of credit bankcards requested.

JSON String

bank_card_details_credit_requested

Type

String. Static Variables below.

Required

Conditional

Comments

Required if merchant is wanting to accept any of the below credit bankcard types.

Valid Values:

XS_CREDIT_REQUESTED_VISA_CREDIT = "Visa Credit";

XS_CREDIT_REQUESTED_MASTERCARD_CREDIT = "Mastercard Credit";

XS_CREDIT_REQUESTED_DISCOVER_CREDIT = "Discover Credit";


Debit Brands Requested

Description

Bankcard debit brands the Merchant is requesting to accept.

JSON String

bank_card_details_debit_brands_requested

Type

String. Static Variables below.

Required

Conditional

Comments

Required if merchant is wanting to accept any of the below Debit bankcard types. (This is NOT for PIN DEBIT)\

Valid Values:

XS_DEBIT_BRANDS_REQUESTED_VISA = "Visa Debit";

XS_DEBIT_BRANDS_REQUESTED_MASTERCARD = "MasterCard Debit";

XS_DEBIT_BRANDS_REQUESTED_DISCOVER = "Discover Debit";


Other Brands Requested

Description

Other brands the Merchant is requesting to accept.

JSON String

bank_card_details_other_brands_requested

Type

String. Static Variables below.

Required

Conditional

Comments

Required if merchant is wanting to accept any of the below Other bankcard types.

Valid Values:

XS_OTHER_BRANDS_REQUESTED_AMERICAN_EXPRESS = "American Express";

XS_OTHER_BRANDS_REQUESTED_PIN_DEBIT = "Pin Debit";

XS_OTHER_BRANDS_REQUESTED_EBT = "EBT";


Currently Accept AMEX

Description

Does this Merchant current accept American Express via an AMEX ESA Account.

JSON String

bank_card_details_currently_accept_amex

Type

Boolean

Required

Conditional

Comments

Required if merchant is currently accepting AMEX Via an ESA account and wish to retain the ESA number.


AMEX Current Number

Description

The Merchant's current AMEX ESA Number.

JSON String

bank_card_details_amex_current_number

Type

String

Required

Conditional

Comments

Required if Currently Accept AMEX = True


Authorization Methods

All auth methods must add up to 100%


Card Present Percentage

Description

The (estimated) percentage of bankcard revenue where the card is physically swiped through a card reader.

JSON String

bank_card_details_card_present_percentage

Type

Double

Required

Conditional

Comments

Required if merchant will be performing card present transactions.


Internet Percentage

Description

The (estimated) percentage of bankcard revenue originating from online sales.

JSON String

bank_card_details_internet_percentage

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting transactions via a website.


Mail Order Percentage

Description

The (estimated) percentage of bankcard revenue originating from mail orders.

JSON String

bank_card_details_mail_order_percentage

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting transactions via Mail Order.


Telephone Order Percentage

Description

The (estimated) percentage of bankcard revenue originating from telephone orders.

JSON String

bank_card_details_telephone_order_percentage

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting transactions via the Telephone.


Payment Thresholds

The below fields will set the bank card payment thresholds.


Average Ticket Amount

Description

The average (estimated) single transaction dollar amount for bankcard transactions (VI,MC,DI)

JSON String

bank_card_details_average_ticket_amount

Type

Double

Required

Yes


Average Monthly Volume

Description

The average (estimated) monthly dollar amount for bankcard transactions. (VI,MC,DI)

JSON String

bank_card_details_average_monthly_volume

Type

Double

Required

Yes


Max Ticket

Description

The maximum (estimated) transaction dollar amount for a single transaction. (VI,MC,DI)

JSON String

bank_card_details_max_ticket

Type

Double

Required

Yes


Max Monthly Volume

Description

The maximum (estimated) monthly dollar amount for bankcard transactions. (VI,MC,DI)

JSON String

bank_card_details_max_monthly_volume

Type

Double

Required

Yes


AMEX Average Ticket Amount

Description

The average (estimated) single ticket dollar amount for an American Express transaction.

JSON String

bank_card_details_amex_average_ticket_amount

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Average Monthly Volume

Description

The average (estimated) monthly dollar amount for American Express transactions.

JSON String

bank_card_details_amex_average_monthly_volume

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Max Ticket

Description

The (estimated) maximum single ticket dollar amount for an American Express transaction.

JSON String

bank_card_details_amex_max_high_ticket_amount

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Max Monthly Volume

Description

The maximum (estimated) monthly dollar amount for American Express transactions.

JSON String

bank_card_details_amex_max_monthly_volume

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


General Account Fees

These sections will determine what general account fees are assessed on the merchant account.


AVS Fee

Description

Fee per Address Verification System(AVS) Request.

JSON String

bank_card_details_avs

Type

Double

Required

No


Batch Settlement

Description

Fee per Batch Settlement.

JSON String

bank_card_details_batch_settlement

Type

Double

Required

No


Chargeback Fee

Description

Non-refundable fee per Merchant chargeback.

JSON String

bank_card_details_chargeback_fee

Type

Double

Required

Yes

Comments

($35 unless otherwise approved by Base Commerce)


Gateway Access

Description

The monthly fee assessed for access to the bankcard gateway.

JSON String

bank_card_details_gateway_access

Type

Double

Required

No


Gateway Transaction

Description

The fee for each transaction through the gateway.

JSON String

bank_card_details_gateway_transaction

Type

Double

Required

No


Monthly Fee

Description

Bankcard fee assessed as a monthly fixed cost of processing.

JSON String

bank_card_details_monthly_fee

Type

Double

Required

No


Minimum Discount

Description

Fee assessed for Merchants who do not meet their monthly minimum transaction volume.

JSON String

bank_card_details_minimum_discount

Type

Double

Required

No


Online Statement Fee

Description

Bankcard fee assessed for online statement access.

JSON String

bank_card_details_online_statement_fee

Type

Double

Required

No


PCI Compliance Monthly

Description

Fee assessed for processing through a PCI compliant system. Payment Card Industry Data Security Standard (PCI DSS) compliance is designed to protect businesses and their customers against payment card theft and fraud.

JSON String

bank_card_details_pci_compliance_monthly

Type

Double

Required

Yes


PCI Non-Compliance Monthly

Description

Fee assessed when a Merchant has not complied with Payment Card Industry Data Security Standards (PCIDSS).

JSON String

 

Type

Double

Required

 Yes


Wireless Fee

Description

A monthly fee for the GPRS wireless server.

JSON String

bank_card_details_wireless_fee

Type

Double

Required

No


Retrivial Fee

Description

A fee assessed when a card issuer issues a Retrivial Request to the Merchant for proof of cardholder participation in a transaction.

JSON String

bank_card_details_retrieval_fee

Type

Double

Required

Yes

Comments

Required to be $7.50 unless otherwise approved by Base Commerce.


Early Termination Fee

Description

A fee assessed if the Merchant cancels their Merchant Contract before a specified time period set forth in the contract.

JSON String

bank_card_details_early_termination_fee

Type

Double

Required

No


Pin Debit ATM Transaction Fee

Description

A flat fee applied to any Pin Debit ATM transactions instead of following the chosen pricing program.

JSON String

bank_card_details_pin_debit_atm_transaction

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting PIN DEBIT Transactions.


Fee Other

Description

A place to note special conditions for the fees ( i.e. ‘Annual Fee collected in month 3’ ).

JSON String

bank_card_details_fee_other

Type

String. Max Length 200 Characters.

Required

No.


Bank Card Pricing

One of the below pricing options must be chosen if the merchant will be accepting bank card transactions.
  • Pass-Through Plus (PTP) Program
  • Three-Tier Pricing Program
  • Bundled/Flat Rate Pricing Program


Pass-Through Plus (PTP) Program

The Fields listed below are required if participating in the Pass-Through Plus (PTP) Program.


Pass-Through Plus

Description

Pricing where the cost is the interchange rate plus the % amount passed in this field. (VI,MC,DI)

JSON String

bank_card_details_pass_through_plus

Type

Double

Required

Yes

Comments

‘0’ Amount allowed.


Pass-Through Plus Authorization Fee

Description

A fee applied to all bank card authorization attempts. (VI,MC,DI)

JSON String

bank_card_details_authorization_fee_ptp

Type

Double

Required

Yes

Comments

‘0’ Amount Allowed.


Pass-Through Plus Transaction Fee

Description

A per item fee charged to each transaction the Merchant processes through the system. (VI,MC,DI)

JSON String

bank_card_details_transaction_fee_ptp

Type

Double

Required

Yes

Comments

‘0’ Amount Allowed.


AMEX Pass-Through Plus

Description

Pricing where the cost is the interchange rate plus the % amount passed in this field. (AMEX)

JSON String

bank_card_details_amex_pass_through_plus

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express. ‘0’ Amount allowed.


AMEX Pass-Through Plus Authorization Fee

Description

A fee applied to all bank card authorization attempts. (AMEX)

JSON String

bank_card_details_amex_authorization_fee_ptp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express. ‘0’ Amount Allowed.


AMEX Pass-Through Plus Transaction Fee

Description

A per item fee charged to each transaction the Merchant processes through the system. (AMEX)

JSON String

bank_card_details_amex_transaction_fee_ptp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express. ‘0’ Amount Allowed.


Three-Tier Pricing Program

These fields are required if participating in the Three-Tier Pricing Program.


Qual Rate

Description

The % rate for the first tier when participating in the 3 tier program. (VI,MC,DI)

JSON String

bank_card_details_qual_rate

Type

Double

Required

Yes


Mid-Qual Rate

Description

The % rate for the middle tier when participating in the 3 tier program. (VI,MC,DI)

JSON String

bank_card_details_mid_qual_rate

Type

Double

Required

Yes


Non-Qual Rate

Description

The % rate for the thrid tier when participating in the 3 tier program. (VI,MC,DI)

JSON String

bank_card_details_non_qual_rate

Type

Double

Required

Yes


Three-Tier Pricing Authorization Fee

Description

A fee applied to all bank card authorization attempts. (VI,MC,DI)

JSON String

bank_card_details_authorization_fee_ttp

Type

Double

Required

Yes

Comments

‘0’ Amont Allowed.


Three-Tier Transaction Fee

Description

A per item fee charged to each transaction the Merchant processes through the system. (VI,MC,DI)

JSON String

bank_card_details_transaction_fee_ttp

Type

Double

Required

Yes

Comments

‘0’ Amount Allowed.


AMEX Qual Discount Rate

Description

The % rate for the first tier when participating in the 3 tier program. (AMEX)

JSON String

bank_card_details_amex_qual_discount_rate

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Mid-Qual Discount Rate

Description

The % rate for the middle tier when participating in the 3 tier program. (AMEX)

JSON String

bank_card_details_amex_mid_qual_discount_rate

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Non-Qual Discount Rate

Description

The % rate for the thrid tier when participating in the 3 tier program. (AMEX)

JSON String

bank_card_details_amex_non_qual_discount_rate

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express.


AMEX Three-Tier Pricing Authorization Fee

Description

A fee applied to all bank card authorization attempts. (AMEX)

JSON String

bank_card_details_amex_authorization_fee_ttp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting Amercian Express. ‘0’ Amont Allowed.


AMEX Three-Tier Pricing Transaction Fee

Description

A per item fee charged to each transaction the Merchant processes through the system. (AMEX)

JSON String

bank_card_details_amex_transaction_fee_ttp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express. ‘0’ Amount Allowed.


Bundled/Flat Rate Pricing Program

These 6 fields are required if participating in the Bundled / Flat Rate Pricing Program.


Bundled Single Rate

Description

A fee applied to all bank card authorization attempts. (VI,MC,DI)

JSON String

bank_card_details_authorization_fee_brp

Type

Double

Required

Yes

Comments

‘0’ Amont Allowed.


Bundled Rate Program Authorization Fee

Description

A fee applied to all bank card authorization attempts. (VI,MC,DI)

JSON String

bank_card_details_authorization_fee_brp

Type

Double

Required

Yes

Comments

‘0’ Amont Allowed.


Bundled Single Rate Program Transaction Fee

Description

A per item fee charged to each transaction the Merchant processes through the system. (VI,MC,DI)

JSON String

bank_card_details_transaction_fee_brp

Type

Double

Required

Yes

Comments

‘0’ Amount Allowed.


AMEX Flat Discount Rate

Description

Flat % Rate to be charged for all AMEX Transactions.

JSON String

bank_card_details_amex_flat_discount_rate

Type

Double

Required

Yes


AMEX Bundled Rate Program Authorization Fee

Description

A fee applied to all bank card authorization attempts. (AMEX)

JSON String

bank_card_details_amex_authorization_fee_brp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting Amercian Express. ‘0’ Amont Allowed.


AMEX Bundled Rate Program Transaction Fee

Description

A per item fee charged to each transaction the merchant processes through the system. (AMEX)

JSON String

bank_card_details_amex_transaction_fee_brp

Type

Double

Required

Conditional

Comments

Required if merchant will be accepting American Express. ‘0’ Amount Allowed.


Recurring Payments

Description

Indicates if the Merchant will be performing recurring bank card payments.

JSON String

bank_card_details_recurring

Type

Boolean

Required

Yes


Cardholder Data Stored Locally

Description

Is cardholder data stored locally?

JSON String

bank_card_details_cardholder_data_stored_locally

Type

Boolean

Required

No


Previously Terminated as a Visa/MasterCard Merchant

Description

Did Visa or MasterCard previously terminate the Merchant?

JSON String

bank_card_details_prev_term_as_a_visa_mc_merchant

Type

Boolean

Required

No


Visa/MasterCard Signage

Description

Is their Visa/MasterCard signage in place?

JSON String

bank_card_details_visa_mc_signage

Type

Boolean

Required

No


3rd Party Access to Cardholder Data

Description

Does a Third Party have access to cardholder data?

JSON String

bank_card_details_3rd_party_access_to_cardholder_data

Type

Boolean

Required

No


Cardholder Charged

Description

When is the cardholder charged?

JSON String

bank_card_details_cardholder_charged

Type

String. Static Variables below.

Required

No

Comments

Valid Values:

XS_CARDHOLDER_CHARGED_PURCHASE = "Purchase";

XS_CARDHOLDER_CHARGED_SHIPMENT = "Shipment";



BankCardDetails o_bc_details = new BankCardDetails();
          o_bc_details.addCreditRequested( BankCardDetails.XS_CREDIT_REQUESTED_VISA_CREDIT );
          o_bc_details.addCreditRequested( BankCardDetails.XS_CREDIT_REQUESTED_MASTERCARD_CREDIT );
          o_bc_details.addCreditRequested( BankCardDetails.XS_CREDIT_REQUESTED_DISCOVER_CREDIT );
          o_bc_details.addDebitBrandsRequested( BankCardDetails.XS_DEBIT_BRANDS_REQUESTED_VISA);
          o_bc_details.addDebitBrandsRequested( BankCardDetails.XS_DEBIT_BRANDS_REQUESTED_MASTERCARD );
          o_bc_details.addDebitBrandsRequested( BankCardDetails.XS_DEBIT_BRANDS_REQUESTED_DISCOVER );
          o_bc_details.addDebitSignatureCardsRequested( BankCardDetails.XS_DEBIT_SIGNATURE_CARDS_REQUESTED_VISA );
          o_bc_details.addDebitSignatureCardsRequested( BankCardDetails.XS_DEBIT_SIGNATURE_CARDS_REQUESTED_MASTERCARD );
          o_bc_details.addDebitSignatureCardsRequested( BankCardDetails.XS_DEBIT_SIGNATURE_CARDS_REQUESTED_DISCOVER );
          o_bc_details.addOtherBrandsRequested( BankCardDetails.XS_OTHER_BRANDS_REQUESTED_AMERICAN_EXPRESS );
          o_bc_details.setCardPresentPercentage( 50 );
          o_bc_details.setInternetPercentage( 50 );
          o_bc_details.setAverageTicketAmount( 500 );
          o_bc_details.setAverageMonthlyVolume( 125000 );
          o_bc_details.setMaxTicket( 2000 );
          o_bc_details.setMaxMonthlyVolume( 200000 );
          o_bc_details.setAmexAverageTicketAmount( 500 );
          o_bc_details.setAmexAverageMonthlyVolume( 125000 );
          o_bc_details.setAmexMaxTicket( 2000 );
          o_bc_details.setAmexMaxMonthlyVolume( 200000 );
          o_bc_details.setAvs( 0.02 );
          o_bc_details.setBatchSettlement( 0.1 );
          o_bc_details.setChargebackFee( 35 );
          o_bc_details.setPciComplianceMonthly( 3.95 );
          o_bc_details.setRetrievalFee( 7.5 );
          o_bc_details.setPassThroughPlus( 0.45 );
          o_bc_details.setAuthorizationFee( 0.1 );
          o_bc_details.setTransactionFee( 0 );
          o_bc_details.setAmexPassThroughPlus( 0.45 );
          o_bc_details.setAmexAuthorizationFee( 0.1);
          o_bc_details.setAmexTransactionFee( 0 );
          o_bc_details.setRecurring( true );
          o_bc_details.setCardHolderDataStoredLocally( false );
          o_bc_details.setPrevTermAsAVisaMcMerchant( false );
          o_bc_details.setVisaMcSignage( true );
          o_bc_details.set3rdPartyAccessToCardholderData( false );
o_location.SetBankCardDetails( o_bc_details );