Recurring Variables

POST URL

POST URL:	https://gateway.bancedge.com/api/transact.php

Add a Plan

Variable Name	Description
recurring*	Add a recurring plan that subscriptions can be added to in the future. Value: ‘add_plan’
plan_payments*	The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled
plan_amount*	The plan amount to be charged each billing cycle. Format: x.xx
plan_name*	The display name of the plan.
plan_id*	The unique plan ID that references only this recurring plan.
day_frequency**	How often, in days, to charge the customer. Cannot be set with ‘month_frequency’ or ‘day_of_month’.
month_frequency***	How often, in months, to charge the customer. Cannot be set with ‘day_frequency’. Must be set with ‘day_of_month’. Values: 1 through 24
day_of_month***	The day that the customer will be charged. Cannot be set with ‘day_frequency’. Must be set with ‘month_frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day

Field markers

• * Always required
• ** Required unless ‘month_frequency’ and ‘day_of_month’ is set.
• *** Required unless ‘day_frequency’ is set.

Edit a Plan

Variable Name	Description
recurring*	Edit an existing recurring plan. Value: ‘edit_plan’ - Be careful when editing an existing plan, as all customers signed up for this plan will have their billing changed based on your edits.
current_plan_id*	Only relevant for editing an existing plan, the value will be the ‘plan_id’ that will be edited in this request.
plan_payments	The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled
plan_amount	The plan amount to be charged each billing cycle. Format: x.xx
plan_name	The display name of the plan.
plan_id	The unique plan ID that references only this recurring plan.
day_frequency**	How often, in days, to charge the customer. Cannot be set with ‘month_frequency’ or ‘day_of_month’.
month_frequency***	How often, in months, to charge the customer. Cannot be set with ‘day_frequency’. Must be set with ‘day_of_month’. Values: 1 through 24
day_of_month***	The day that the customer will be charged. Cannot be set with ‘day_frequency’. Must be set with ‘month_frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day

Field markers

• * Always required
• ** Required unless ‘month_frequency’ and ‘day_of_month’ is set.
• *** Required unless ‘day_frequency’ is set.

Add a Subscription to an Existing Plan

Variable Name	Description
recurring*	Associate payment information with a recurring plan. Value: add_subscription
plan_id*	The plan ID of the plan that the subscription will be associated with.
start_date	The first day that the customer will be charged. Format: YYYYMMDD
payment_token	The tokenized version of the customer’s card or check information. This will be generated by Collect.js and is usable only once.
googlepay_payment_data	The encrypted token created when using integration directly to the Google Pay SDK.
applepay_payment_data	The encrypted token created when using integration directly to the Apple Pay SDK.
ccnumber**	Credit card number.
ccexp**	Credit card expiration. Format: MMYY
cavv†	Cryptogram from decrypted Apple Pay or Google Pay data Format: base64 encoded
decrypted_applepay_data†	Indicator that the ccnumber, ccexp, and cavv fields contain decrypted Apple Pay data Value: 1
decrypted_googlepay_data†	Indicator that the ccnumber, ccexp, and cavv fields contain decrypted Google Pay data Value: 1
payment***	The type of payment. Default: ‘creditcard’ Values: ‘creditcard’ or ‘check’
checkname***	The name on the customer’s ACH account.
checkaccount***	The customer’s bank account number.
checkaba***	The customer’s bank routing number.
account_type	The customer’s ACH account type. Values: ‘checking’ or ‘savings’
currency	Set transaction currency.
account_holder_type	The customer’s ACH account entity. Values: ‘personal’ or ‘business’
sec_code	ACH standard entry class codes. Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
first_name	Cardholder’s first name. Legacy variable includes: firstname
last_name	Cardholder’s last name. Legacy variable includes: lastname
address1	Card billing address.
city	Card billing city
state	Card billing state.
zip	Card billing postal code.
country	Card billing country code.
phone	Billing phone number.
email	Billing email address.
company	Cardholder’s company.
address2	Card billing address, line 2.
fax	Billing fax number.
orderid	Order ID
order_date	Order Date
order_description	Order Description
merchant_defined_field_#	Can be set up in merchant control panel under ‘Settings’->‘Merchant Defined Fields’.
ponumber	Cardholder’s purchase order number.
processor_id	If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
customer_receipt	If set to true, when the customer is charged, they will be sent a transaction receipt. Values: ‘true’ or ‘false’
source_transaction_id	Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
acu_enabled	If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs. Default: ‘true’ Values: ‘true’ or ‘false’

Field markers

• * Always required
• ** Required for credit card transactions
• *** Required for ACH transactions
• † Required for Digital Wallet transactions with merchant-decrypted data

Adding a Custom Subscription

Variable Name	Description
recurring*	Add a custom recurring subscription that is NOT associated with an existing plan Value: ‘add_subscription’
plan_payments*	The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled
plan_amount*	The plan amount to be charged each billing cycle. Format: x.xx
day_frequency**	How often, in days, to charge the customer. Cannot be set with ‘month_frequency’ or ‘day_of_month’.
month_frequency***	How often, in months, to charge the customer. Cannot be set with ‘day_frequency’. Must be set with ‘day_of_month’. Values: 1 through 24
day_of_month***	The day that the customer will be charged. Cannot be set with ‘day_frequency’. Must be set with ‘month_frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
start_date	The first day that the customer will be charged. Format: YYYYMMDD
payment_token	The tokenized version of the customer’s card or check information. This will be generated by Collect.js and is usable only once.
googlepay_payment_data	The encrypted token created when using integration directly to the Google Pay SDK.
applepay_payment_data	The encrypted token created when using integration directly to the Apple Pay SDK.
ccnumber****	Credit card number.
ccexp****	Credit card expiration. Format: MMYY
cavv††	Cryptogram from decrypted Apple Pay or Google Pay data Format: base64 encoded
decrypted_applepay_data††	Indicator that the ccnumber, ccexp, and cavv fields contain decrypted Apple Pay data Value: 1
decrypted_googlepay_data††	Indicator that the ccnumber, ccexp, and cavv fields contain decrypted Google Pay data Value: 1
payment†	The type of payment. Default: ‘creditcard’ Values: ‘creditcard’ or ‘check’
checkname†	The name on the customer’s ACH account.
checkaccount†	The customer’s bank account number.
checkaba†	The customer’s bank routing number.
account_type	The customer’s ACH account type. Values: ‘checking’ or ‘savings’
account_holder_type	The customer’s ACH account entity. Values: ‘personal’ or ‘business’
sec_code	ACH standard entry class codes. Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
first_name	Cardholder’s first name. Legacy variable includes: firstname
last_name	Cardholder’s last name. Legacy variable includes: lastname
address1	Card billing address.
city	Card billing city
state	Card billing state.
zip	Card billing postal code.
country	Card billing country code.
phone	Billing phone number.
email	Billing email address.
company	Cardholder’s company.
address2	Card billing address, line 2.
fax	Billing fax number.
orderid	Order ID
order_date	Order Date
order_description	Order Description Legacy variable includes: orderdescription
merchant_defined_field_#	Can be set up in merchant control panel under ‘Settings’->‘Merchant Defined Fields’.
ponumber	Cardholder’s purchase order number.
processor_id	If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
customer_receipt	If set to true, when the customer is charged, they will be sent a transaction receipt. Values: ‘true’ or ‘false’
source_transaction_id	Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
acu_enabled	If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs. Default: ‘true’ Values: ‘true’ or ‘false’
paused_subscription	If set to true, the subscription will be paused. Values: ‘true’ or ‘false’

Field markers

• * Always required
• ** Required unless ‘month_frequency’ and ‘day_of_month’ is set.
• *** Required unless ‘day_frequency’ is set.
• **** Required for credit card transactions
• † Required for ACH transactions
• †† Required for Digital Wallet transactions with merchant-decrypted data

Update a Custom Subscription’s Plan Details

Variable Name	Description
recurring*	Update the subscription’s billing information. Value: ‘update_subscription’
subscription_id*	The subscription ID that will be updated.
plan_payments	The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled
plan_amount	The plan amount to be charged each billing cycle. Format: x.xx
day_frequency	How often, in days, to charge the customer. Cannot be set with ‘month_frequency’ or ‘day_of_month’.
month_frequency	How often, in months, to charge the customer. Cannot be set with ‘day_frequency’. Must be set with ‘day_of_month’. Values: 1 through 24
day_of_month	The day that the customer will be charged. Cannot be set with ‘day_frequency’. Must be set with ‘month_frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day

Field markers

• * Always required

Update Subscription

Variable Name	Description
recurring*	Update the subscription’s billing information. Value: ‘update_subscription’
subscription_id*	The subscription ID that will be updated.
plan_payments	The number of payments before the recurring plan is complete. Notes: ‘0’ for until canceled
plan_amount	The plan amount to be charged each billing cycle. Format: x.xx
day_frequency	How often, in days, to charge the customer. Cannot be set with ‘month_frequency’ or ‘day_of_month’.
month_frequency	How often, in months, to charge the customer. Cannot be set with ‘day_frequency’. Must be set with ‘day_of_month’. Values: 1 through 24
day_of_month	The day that the customer will be charged. Cannot be set with ‘day_frequency’. Must be set with ‘month_frequency’. Values: 1 through 31 - for months without 29, 30, or 31 days, the charge will be on the last day
start_date	The first day that the customer will be charged. Format: YYYYMMDD
payment_token	The tokenized version of the customer’s card or check information. This will be generated by Collect.js and is usable only once.
googlepay_payment_data	The encrypted token created when integration directly to the Google Pay SDK.
ccnumber	Credit card number.
ccexp	Credit card expiration. Format: MMYY
checkname	The name on the customer’s ACH account.
checkaccount	The customer’s bank account number.
checkaba	The customer’s bank routing number.
account_type	The customer’s ACH account type. Values: ‘checking’ or ‘savings’
account_holder_type	The customer’s ACH account entity. Values: ‘personal’ or ‘business’
sec_code	ACH standard entry class codes. Values: ‘PPD’, ‘WEB’, ‘TEL’, or ‘CCD’
first_name	Cardholder’s first name. Legacy variable includes: firstname
last_name	Cardholder’s last name. Legacy variable includes: lastname
address1	Card billing address.
city	Card billing city
state	Card billing state.
zip	Card billing postal code.
country	Card billing country code.
phone	Billing phone number.
email	Billing email address.
company	Cardholder’s company.
address2	Card billing address, line 2.
fax	Billing fax number.
orderid	Order ID
order_date	Order Date
order_description	Order Description Legacy variable includes: orderdescription
merchant_defined_field_#	Can be set up in merchant control panel under ‘Settings’->‘Merchant Defined Fields’.
ponumber	Cardholder’s purchase order number.
processor_id	If using Multiple MIDs, route to this processor (processor_id is obtained under Settings->Transaction Routing in the Control Panel).
customer_receipt	If set to true, when the customer is charged, they will be sent a transaction receipt. Values: ‘true’ or ‘false’
source_transaction_id	Specifies a payment gateway transaction id in order to associate payment information with a Subscription record.
acu_enabled	If set to true, credit card will be evaluated and sent based upon Automatic Card Updater settings. If set to false, credit card will not be submitted for updates when Automatic Card Updater runs. Default: ‘true’ Values: ‘true’ or ‘false’
paused_subscription	If set to true, the subscription will be paused. Values: ‘true’ or ‘false’

Field markers

• * Always required

Delete a Subscription

Variable Name	Description
recurring*	Delete the subscription. Customer will no longer be charged. Value: ‘delete_subscription’
subscription_id*	The subscription ID that will be deleted.

Field markers

• * Always required