NATS4 CardFlex

From TMM Wiki
Jump to navigationJump to search
NATS 5
    Biller Instructions
NATS Biller List
2000Charge
2000Charge Gateway
2KCHARGE
A1Payments
Aebill
Aconti
Allopass
AltoBilling
Argus
Authorize.net
Bill1st Gateway
BillAPay Gateway
Billing Revolution
Billing United
Bit-Pay
BoaCompra
Braintree Payments
C2Bill
CardFlex
CCBill
CCBill Flexform
CCBill Web900
CashSend
CashtoCode
Centili
Centrobill
Clearcard
Clearcard IDV
Click and Buy
CoinGate
CoinPayments
CommerceGate
CurePay
DHD
DHDGateway
DIMOCO
EGatePay
ElectraCash
eMerchantPay Gateway
eMPPay.com
Epoch
Escalion
EuroBill
EPGBill.com
Ezic, Inc.
Focal Payments
FXBilling
FXBilling Native
Gateway tokens
Gigadat
Global Access
GlobalCharge
Global DPS
GoCoin
Greta 11 (G11Bill)
GTBill
GTBill GATEWAY
GXBill
ICN Ltd.
Itelebill
Jettis International
Jettis International Gateway
LocalBilling
MobiusPay
MerlinBill
NETbilling
NETbilling Native
NetCash
NetMobile
Netpay International
NoCreditCard
OrbitalPay
Password By Phone
Pay4
Pay900
Payment Network
Paygarden
Paygea
PayPal
Paysite Cash
Payspace
Payspace Gateway
Plug'n Pay
Prime Orange
Probiller
PumaPay
Rocketfuel
RocketGate
RocketGate Native
RSBilling
RSBilling Native
SafeCharge
SafeCharge Native
Secure Billing Worldwide
Secure Billing Worldwide Gateway
Secure Trading
SecurionPay
SegPay
SegPay Gateway
SOFORTdauerauftrag
Sonic Bill
StandardBill
TrustCharge
Telecom
UKash
Vendo Services
Vendo
Verotel Pro
Voxtel
VXSBill
WebBilling
Wispay
WTS
WTSeu
Zombaio
Shopping Cart Sales
Switching From Epoch to Epoch EU
Members Section
Members Management
Adding a Member
View Member Details
Restricted Values
OpenID Connect
Mod Auth OpenIDC
    Adtool
GET /adtool/admin
GET /adtool/adtools
GET /adtool/adtool
GET /adtool/adtool-rules
GET /adtool/adtool-rule
GET /adtool/categories
GET /adtool/field-options
GET /adtool/field-types
GET /adtool/groups
GET /adtool/search
GET /adtool/templates
GET /adtool/types
GET /adtool/type
POST /adtool/adtool
POST /adtool/adtool-rule
POST /adtool/category
POST /adtool/field
POST /adtool/field-option
POST /adtool/group
POST /adtool/import
POST /adtool/type
PATCH /adtool/adtool
PATCH /adtool/adtool-group
PATCH /adtool/adtool-rule
PATCH /adtool/category
PATCH /adtool/field
PATCH /adtool/field-option
PATCH /adtool/group
PATCH /adtool/move
PATCH /adtool/restore-adtool
PATCH /adtool/restore-category
PATCH /adtool/restore-field
PATCH /adtool/restore-field-option
PATCH /adtool/restore-type
PATCH /adtool/type
DELETE /adtool/adtool
DELETE /adtool/adtool-rule
DELETE /adtool/category
DELETE /adtool/field
DELETE /adtool/field-option
DELETE /adtool/group
DELETE /adtool/type
    Affiliate
DELETE /affiliate/account-rep
DELETE /affiliate/account-type
DELETE /affiliate/affiliate
DELETE /affiliate/doc
DELETE /affiliate/group
DELETE /affiliate/permissions
GET /affiliate/account-changes
GET /affiliate/account-types
GET /affiliate/admin-settings
GET /affiliate/campaigns
GET /affiliate/current
GET /affiliate/current-permissions
GET /affiliate/docs
GET /affiliate/doc
GET /affiliate/groups
GET /affiliate/group
GET /affiliate/hits
GET /affiliate/link-styles
GET /affiliate/loginids
GET /affiliate/loginlog
GET /affiliate/manual-payout
GET /affiliate/news-sections
GET /affiliate/notes
GET /affiliate/notices
GET /affiliate/override
GET /affiliate/payout
GET /affiliate/payment-periods
GET /affiliate/payvia-types
GET /affiliate/payvia-type
GET /affiliate/permissions
GET /affiliate/programcampaigns
GET /affiliate/referrer
GET /affiliate/referring-urls
GET /affiliate/reps
GET /affiliate/rest-methods
GET /affiliate/search
GET /affiliate/search-limited
GET /affiliate/settings
GET /affiliate/skins
GET /affiliate/soap-functions
GET /affiliate/status
PATCH /affiliate/adminsettings
PATCH /affiliate/account-change
PATCH /affiliate/account-type
PATCH /affiliate/account-type-permissions
PATCH /affiliate/admin-setting
PATCH /affiliate/affiliate-account-type
PATCH /affiliate/affiliate-group
PATCH /affiliate/allsettings
PATCH /affiliate/account-rep
PATCH /affiliate/avatar
PATCH /affiliate/customs
PATCH /affiliate/defaults
PATCH /affiliate/details
PATCH /affiliate/override
PATCH /affiliate/password
PATCH /affiliate/payment-period
PATCH /affiliate/payvia
PATCH /affiliate/payvia-info
PATCH /affiliate/permissions
PATCH /affiliate/referrer
PATCH /affiliate/reset-api
PATCH /affiliate/reset-rss
PATCH /affiliate/reset-tos
PATCH /affiliate/rest-permissions
PATCH /affiliate/restore
PATCH /affiliate/restore-account-type
PATCH /affiliate/settings
PATCH /affiliate/soap-permissions
PATCH /affiliate/status
POST /affiliate/account-type
POST /affiliate/add
POST /affiliate/doc
POST /affiliate/group
POST /affiliate/invoice
POST /affiliate/manual-sale
POST /affiliate/note
    Biller
GET /biller/available
GET /biller/partner-available
GET /biller/billerdata
GET /biller/cascades
GET /biller/cascades-available
GET /biller/cascade-count
GET /biller/cascade-history
GET /biller/cascade-rules
GET /biller/cascade-rule
GET /biller/cascade-step-count
GET /biller/cascade-steps
GET /biller/cascade-detail
GET /biller/cascade-list
GET /biller/count
GET /biller/detail
GET /biller/fees
GET /biller/partner-fees
GET /biller/last_poll
GET /biller/partner-last-poll
GET /biller/list
GET /biller/partner-detail
GET /biller/partner-list
GET /biller/partner-shortnames
GET /biller/process_types
GET /biller/partner-process-types
GET /biller/shortnames
GET /biller/transaction_types
GET /biller/partner-transaction-types
GET /biller/taxes
POST /biller/add
POST /biller/cascade
POST /biller/cascade-rule
POST /biller/cascade-step
POST /biller/partner
PATCH /biller/cascade
PATCH /biller/cascade-rule
PATCH /biller/cascade-step
PATCH /biller/cascade-steps-reorder
PATCH /biller/fee
PATCH /biller/partner-fee
PATCH /biller/restore
PATCH /biller/restore-cascade
PATCH /biller/restore-partner
PATCH /biller/setting
PATCH /biller/partner-setting
PATCH /biller/tax
DELETE /biller/biller
DELETE /biller/cascade
DELETE /biller/cascade-rule
DELETE /biller/cascade-step
DELETE /biller/fee
DELETE /biller/partner-fee
DELETE /biller/partner
DELETE /biller/tax
    Codes
GET /codes/affiliate-codes
GET /codes/decode
GET /codes/linkcodes
GET /codes/strack
    Config
DELETE /config/setting
GET /config/section
GET /config/sections
PATCH /config/affiliate_default
PATCH /config/section
    Include
DELETE /include/include
DELETE /include/step
GET /include/include
GET /include/includes
GET /include/templates
PATCH /include/include
PATCH /include/restore
PATCH /include/step
POST /include/include
POST /include/step
    Mailing
DELETE /mailing/mailing
DELETE /mailing/mailing-rule
DELETE /mailing/queue
GET /mailing/mailing
GET /mailing/mailings
GET /mailing/mailing-rules
GET /mailing/mailing-rule
GET /mailing/queue
GET /mailing/removelist
PATCH /mailing/mailing
PATCH /mailing/mailing-rule
PATCH /mailing/removelist
PATCH /mailing/removelist-queue
PATCH /mailing/resend-queue
PATCH /mailing/restore-queue
PATCH /mailing/send-mailing
PATCH /mailing/send-test-mailing
POST /mailing/mailing
POST /mailing/mailing-rule
POST /mailing/removelist
    Maintenance
DELETE /maintenance/log
DELETE /maintenance/cache
GET /maintenance/admin-actions
GET /maintenance/log
GET /maintenance/logs
GET /maintenance/nats
GET /maintenance/report
GET /maintenance/report-progress
GET /maintenance/reports
GET /maintenance/server
GET /maintenance/table
GET /maintenance/tables
GET /maintenance/table-clean-count
GET /maintenance/table-clean-progress
PATCH /maintenance/log
PATCH /maintenance/report
PATCH /maintenance/table
    Member
GET /member/available_flags
GET /member/encryptusername
GET /member/authstring
GET /member/details
GET /member/flags
GET /member/loginlog
GET /member/matching
GET /member/notes
GET /member/notices
GET /member/restricted-values
GET /member/search
GET /member/suggestedcanceloffers
GET /member/surfer-actions
PATCH /member/details
PATCH /member/expiration
PATCH /member/expiremanual
PATCH /member/resend-transaction-email
PATCH /member/resend-transaction-postback
PATCH /member/restricted-value
PATCH /member/forget
PATCH /member/lock
PATCH /member/unlock
POST /member/flag
POST /member/login
POST /member/note
POST /member/restricted-value
DELETE /member/flag
DELETE /member/restricted-value
    Message
DELETE /message/message
DELETE /message/permanent
GET /message/count
GET /message/messages
GET /message/view
PATCH /message/read
PATCH /message/unread
PATCH /message/undelete
POST /message/message
    News
DELETE /news/entry
DELETE /news/section
GET /news/entry
GET /news/news
GET /news/sections
PATCH /news/entry
POST /news/entry
POST /news/section
    Notification
DELETE /notification/notification
DELETE /notification/permanent
GET /notification/count
GET /notification/notifications
GET /notification/view
PATCH /notification/read
PATCH /notification/unread
PATCH /notification/undelete
    Option
GET /option/options
GET /option/rule
PATCH /option/rule
PATCH /option/text
POST /option/rule
    Payment
DELETE /payment/invoice
DELETE /payment/payout-period
DELETE /payment/payvia-field
DELETE /payment/payvia-field-mc
DELETE /payment/payvia-rule
GET /payment/dump-format
GET /payment/dump-formats
GET /payment/invoices
GET /payment/payments
GET /payment/payment-dumps
GET /payment/payment-dump
GET /payment/payment-search
GET /payment/payvia
GET /payment/payvias
GET /payment/payvia-fields
GET /payment/payvia-field-mcs
GET /payment/payout-period
GET /payment/payout-periods
GET /payment/payvia-rules
GET /payment/payvia-rule
GET /payment/payviarule
PATCH /payment/copy-dump-format
PATCH /payment/default-payout-period
PATCH /payment/dump-format
PATCH /payment/duplicate-payvia
PATCH /payment/invoice
PATCH /payment/payment
PATCH /payment/payment-paid
PATCH /payment/payment-store
PATCH /payment/payment-unstore
PATCH /payment/payments
PATCH /payment/payments-unstore
PATCH /payment/payout-period
PATCH /payment/payout-period-affiliates
PATCH /payment/payvia
PATCH /payment/payvia-field
PATCH /payment/payvia-fields-reorder
PATCH /payment/payvia-field-mc
PATCH /payment/payvia-field-mcs-reorder
PATCH /payment/payvia-rule
PATCH /payment/payviarule
PATCH /payment/restore-payout-period
PATCH /payment/restore-payvia-field
PATCH /payment/restore-payvia-field-mc
POST /payment/check-dump
POST /payment/dump-format
POST /payment/import-dump
POST /payment/invoice
POST /payment/payout-period
POST /payment/payvia
POST /payment/payvia-field
POST /payment/payvia-field-mc
POST /payment/payvia-rule
    Program
DELETE /program/program
DELETE /program/payout-change
DELETE /program/payout-change-tier
GET /program/additional-payout-change-targets
GET /program/affiliate-available
GET /program/detail
GET /program/list
GET /program/options
GET /program/payout-changes
GET /program/redirect-available
GET /program/sites
GET /program/tours
GET /program/types
PATCH /program/default_payout
PATCH /program/details
PATCH /program/disable_affiliate
PATCH /program/disable_tour
PATCH /program/enable_affiliate
PATCH /program/enable_site
PATCH /program/enable_tour
PATCH /program/move-payout-change
PATCH /program/payout-change
PATCH /program/payout-change-tier
POST /program/new
POST /program/payout-change
POST /program/payout-change-tier
    Report
GET /report/affiliate-ratios
GET /report/hits
GET /report/hit-totals
GET /report/profitloss
GET /report/profit-loss
GET /report/fields
GET /report/focus
GET /report/focuses
GET /report/groups
GET /report/perspective
GET /report/perspectives
GET /report/report
GET /report/subscription
GET /report/surfer
GET /report/surferaction
GET /report/transactionpayouts
GET /report/transactions
GET /report/transaction
GET /report/report-widget
GET /report/widgets
GET /report/widget
GET /report/widget-info
GET /report/views
POST /report/focus
POST /report/group
POST /report/perspective
PATCH /report/focus
PATCH /report/focus-enabled
PATCH /report/focus-default
PATCH /report/focuses-reorder
PATCH /report/perspective
PATCH /report/perspective-group
PATCH /report/report-widget
PATCH /report/widget
DELETE /report/focus
    Reward
DELETE /reward/category
DELETE /reward/purchase
DELETE /reward/point
DELETE /reward/reward
GET /reward/categories
GET /reward/points
GET /reward/purchases
GET /reward/rewards
PATCH /reward/move-point
PATCH /reward/point
PATCH /reward/reward
PATCH /reward/ship-purchase
PATCH /reward/unship-purchase
POST /reward/category
POST /reward/point
POST /reward/reward
    Service
GET /service/check-functions
GET /service/condition
GET /service/countries
GET /service/country
GET /service/datetime
GET /service/languages
GET /service/periods
GET /service/ping
GET /service/project
GET /service/rule-condition-data
GET /service/rule-info
GET /service/stats-breakdowns
GET /service/timezone
GET /service/timestamp
POST /service/sendemail
    Site
GET /site/base-templates
GET /site/billers
GET /site/cookies
GET /site/coupon
GET /site/coupons
GET /site/coupon-revisions
GET /site/email-settings
GET /site/groups
GET /site/option
GET /site/options
GET /site/options-available
GET /site/option-fields
GET /site/option-rules
GET /site/option-rule
GET /site/option-type
GET /site/option-types
GET /site/programs
GET /site/redirect
GET /site/redirects
GET /site/redirect-rules
GET /site/redirect-rule
GET /site/site-list
GET /site/site
GET /site/site-notices
GET /site/site-partner
GET /site/site-partners
GET /site/site-type
GET /site/sites
GET /site/template
GET /site/templates
GET /site/template-sections
GET /site/template-sites
GET /site/tour
GET /site/tours
GET /site/tour-emails
GET /site/tour-notices
POST /site/coupon
POST /site/group
POST /site/option
POST /site/option-rule
POST /site/redirect
POST /site/redirect-rule
POST /site/site-partner
POST /site/site-tour
POST /site/copy-template
POST /site/tour
PATCH /site/cookie
PATCH /site/coupon
PATCH /site/duplicate-option
PATCH /site/email-settings
PATCH /site/group
PATCH /site/move
PATCH /site/option
PATCH /site/option-rule
PATCH /site/redirect
PATCH /site/redirect-rule
PATCH /site/reset-coupon
PATCH /site/restore-group
PATCH /site/restore-option
PATCH /site/restore-redirect
PATCH /site/restore-site
PATCH /site/restore-site-partner
PATCH /site/restore-tour
PATCH /site/site
PATCH /site/site-partner
PATCH /site/template
PATCH /site/tour
DELETE /site/cookie
DELETE /site/group
DELETE /site/option
DELETE /site/option-rule
DELETE /site/site
DELETE /site/site-partner
DELETE /site/redirect
DELETE /site/redirect-rule
DELETE /site/template
DELETE /site/tour
DELETE /site/tour-field
    Skin
DELETE /skin/skin
DELETE /skin/template
GET /skin/colors
GET /skin/export
GET /skin/skins
GET /skin/sections
GET /skin/templates
GET /skin/template
PATCH /skin/colors
PATCH /skin/flush
PATCH /skin/skin
PATCH /skin/template
POST /skin/copy-template
POST /skin/import
POST /skin/skin
POST /skin/template
NATS 4
Members Admin
The Members Admin
View Member Details
Add Member
MySQL Auth
Mod Authn DB
Multisite Access
Member Logging
Member Password Retrieval
OpenID Connect
Mod Auth OpenIDC
ID Numbers

Setting Up at CardFlex

Before you can begin configuring CardFlex as a biller in NATS4, you must first register a merchant account with them. This can be done through their website at http://www.cardflexpaymentsolutions.com/.

While registering with CardFlex, make sure to take down the Account ID, Password, Merchant Pin, and subid that they provide for you. This information will be necessary for setting up CardFlex in NATS4.

Note: CardFlex requires the PHP function, ssh2. For more information, please see the official PHP manual. The function names that must be used are 'ssh2_connect', and 'ssh2_sftp'.

This biller only supports credit card transactions.

Setting Up CardFlex in NATS

Billers Admin

To begin setting up CardFlex as a biller in NATS, go to the Billers Admin. Scroll down to the "Biller" drop-down menu, select CardFlex, and click "Add."

Note: If you don't see CardFlex as a biller in NATS4, put in a support ticket, as you may need an updated version of NATS.

When prompted, fill in the Account ID, Password, and Merchant Pin that were provided to you by CardFlex under the "Account Info" section. If you were not provided with this information, please contact your biller's support to receive it.

Sites Admin

Next, go to the Sites Admin, create or edit a tour, and scroll down to the "Biller Details" section. Locate the "CARDFLEX Merchant Sub ID" field here, and enter your CardFlex Merchant Sub ID for every join option you set up with CardFlex.

Additionally, you may wish to edit/add any additional rules to allow this option to show on your join page. You can do so with the purple arrows next to the Option row on the main Billers page (similar to the several other areas across NATS).

Once you have completed these steps, save your join option details. CardFlex will now be configured for basic use as a biller in NATS4.

Note: CardFlex only supports the following recurring days as an option for rebills:

  • 7, 31, 30, 120, 180, 365, 14, 730, 28, 1, 60 days, or 0 days (no recurring option).

If the rebill day is set to a different value than above, NATS will skip CardFlex!

Cross Sales

CardFlex also supports Cross Sell transactions through NATS. In order to process cross sale transactions, however, you will first have to set them up with your biller. Please contact CardFlex for assistance with this.

To set up cross sales in NATS, go to the Upsells Admin and click Incoming or Outgoing cross sales from the navigation tabs at the top of the page (depending on whether you are receiving or sending the cross sale).

If you are sending a cross sale to another site, go to the "Outgoing Cross Sales" page. Add CardFlex from the "Biller" drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your cross sell option.

You will then need to fill out the Biller Info for your cross sale, which should have been provided to you by CardFlex. Fill in your Account ID, Merchant Pin, Merchant Sub ID, Ref Code, and Domain here. Once you have done that, fill in the initial membership fee and length for your option, as well as the recurring membership fee and length. Click Save Changes.

If you are receiving the cross sale, go to the "Incoming Cross Sales" page. Add CardFlex from the "Biller" drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with the cross sale.

Under "Details," fill in the title of your cross sale option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Merchant Sub ID number that you received from CardFlex in the "Biller Info" section, and click Save Changes.

Upsells

Upsells can be configured similarly to cross sales in NATS. Like cross sales, you will first have to configure upsells with CardFlex before you can configure them in NATS.

To set up upsells in NATS, go to the Upsells Admin and click Incoming or Outgoing Upsells, depending on whether you are receiving or sending the upsell, from the navigation tabs at the top of the page.

If you are sending the upsell, go to the Outgoing Upsells section. Add CardFlex from the Biller drop-down menu, and click Add New Option. On the next page, you will be prompted to fill in the Title, Description, and Disclaimer for your upsell.

You will then need to fill out the Biller Info for your upsell, which should have been provided to you by CardFlex. Fill in your Ref Code and Domain, as well as whether you want to use an HTTPS Post, and click Save Changes.

If you are receiving the upsell, go to the "Incoming Upsells" section. Add CardFlex from the provided Biller drop-down menu and click Add New Option. When prompted, choose the site and program you want to associate with this upsell.

Under "Details," fill in the title of your upsell option, the initial membership fee and length, and the recurring membership fee and length. Finally, fill in your Merchant ID, Product ID, Upgrade Product Page ID, and Upgrade Product ID in the "Biller Info" section and click Save Changes. CardFlex will now be configured to process Upsell and Cross Sell transactions through NATS4.

Note: CardFlex requires the last four (4) credit card digits for the member that you are upgrading.

UpgradePlus

CardFlex allows you to potentially shorten a Member's Trial by offering them incentives to upgrade in your Members Area. This can be done with the Upgrade Plus feature.

Place the following link in your Members Area to allow upgrade subscriptions with the UpgradePlus feature:

  • http://<linkdomain>/signup/upgradeplus.php?site=<siteid>&username=<username>

Replace <linkdomain> with your linkdomain; replace <siteid> with your sites ID number; replace <username> with the user's username. You can get the current user's username with the following PHP code:

<?=$_SERVER['REMOTE_USER']?>)

For more information on this feature, please see our NATS4 Upgrade Plus wiki article.

Note: CardFlex requires the last four (4) credit card digits for the member that you are upgrading.

Notes

CardFlex only supports the following recurring days as an option for rebills:

  • 7, 31, 30, 120, 180, 365, 14, 730, 28, 1, 60 days, or 0 days (no recurring option).

If the rebill day is set to a different value than above, NATS will skip CardFlex!

CardFlex requires the PHP function, ssh2. For more information, please see the official PHP manual. The function names that must be used are 'ssh2_connect', and 'ssh2_sftp'.