Partner Boarding Merchant

Create new Merchant

Request Method: POST

URL Endpoint: /api/merchant

Name	Type	Default	Description	Required	Regex
name	string		Merchants Name	true	([0-9a-z]{1,100})
description	string		Merchant Description - internal description	true	([0-9a-z]{1,254})
status	string		Account Status	true	(active|disabled)
website	string		Website URL		([0-9a-z]{1,100})
phone	string		Merchant Phone - digits only	true	([0-9]{10})
receipt_email	string		Receipt Email - default receipt from email	true
fee_schedule_id	string		Fee Schedule ID assigned to merchant	true	([0-9a-v]{20})
timezone	string		Timezone - EX America/Chicago	true
accept_tos	bool	false	Should we accept the TOS?
billing	object		Billing details, null if you want to pay fees on behalf of the merchant
billing.ach	object		ACH container
billing.type	string		SEC Type. PPD=Personal CCD=Corporate Account	true	(ppd|ccd)
billing.routing_number	string		ACH Routing Number
billing.account_number	string		ACH Account Number
billing.account_type	string		ACH Account Type	true	(checking|savings)
billing_contact	object
billing_contact.first_name	string		First Name	true	([0-9a-z \w]{1,100})
billing_contact.last_name	string		Last Name	true	([0-9a-z \w]{1,100})
billing_contact.company	string		Company Name	true	([0-9a-z \w]{1,100})
billing_contact.address_line_1	string		Address Line 1	true	([0-9a-z \w]{1,100})
billing_contact.address_line_2	string		Address Line 2	true	([0-9a-z \w]{0,100})
billing_contact.city	string		City	true	([0-9a-z \w]{1,100})
billing_contact.state	string		State	true	([A-Z]{2})
billing_contact.postal_code	string		Postal Code - Validated based on country	true
billing_contact.country	string		Country code	true	([A-Z]{2})
billing_contact.email	string		Email address	true
billing_contact.phone	string		Phone - digits only	true	([0-9]{10})
primary_contact	object
primary_contact.first_name	string		First Name	true	([0-9a-z \w]{1,100})
primary_contact.last_name	string		Last Name	true	([0-9a-z \w]{1,100})
primary_contact.company	string		Company Name	true	([0-9a-z \w]{1,100})
primary_contact.address_line_1	string		Address Line 1	true	([0-9a-z \w]{1,100})
primary_contact.address_line_2	string		Address Line 2	true	([0-9a-z \w]{1,100})
primary_contact.city	string		City	true	([0-9a-z \w]{1,100})
primary_contact.state	string		State	true	([A-Z]{2})
primary_contact.postal_code	string		Postal Code - Validated based on country	true
primary_contact.country	string		Country code	true	([A-Z]{2})
primary_contact.email	string		Email address	true
primary_contact.phone	string		Phone - digits only	true	([0-9]{10})
primary_contact.phone	string		Phone - digits only	true	([0-9]{10})
user	object
user.username	string		Primary user account to create	true	([a-zA-Z][a-zA-Z_0-9.]{6,50})
user.name	string		Users display name	true	([0-9a-z \w]{1,100})
user.phone	string		Phone - digits only	true	([0-9]{10})
user.email	string		Users email address	true
user.timezone	string		Timezone - EX America/Chicago	true
user.status	string		Users status	true	(active|disabled)
user.role	string		Primary users role, should always be admin	true	(admin|standard)
user.send_welcome	bool	false	Toggle to send a welcome email
user.create_api_key	bool	false	Toggle to create the private api key and return it
user.create_pub_api_key	bool	false	Toggle to create the public api key and return it
permissions	object	Use defaults	See below for available permissions. If this object is not passed then it will use the gateway defined defaults. Any permission not provided will default to false

Available Permissions:

Name	Type	Default	Description
support_blind_credits	bool	false	Allow merchant to process blind credits
allow_rule_engine_access	bool	false	Allow merchant to use our fraud rules
allow_invoice_access	bool	false	Allow merchant to use invoicing
allow_customer_vault_access	bool	false	Allow merchant to use customer vault
allow_recurring_billing_access	bool	false	Allow merchant to use recurring billing
allow_cart_access	bool	false	Allow merchant to use our hosted cart
allow_developer_hub_link	bool	false	Allow merchant to see our developer hub link
allow_advanced_fields	bool	false	Allow merchant to pass advanced fields for Level 3
enable_terminal_debit_transactions	bool	false	Allow merchant to process debit transaciton on terminals
allow_defaults_population	bool	false	Allow merchant to use L3 auto population
allow_billing_access	bool	false	Allow merchant to see billing reports, if they are set up as bill Merchant
allow_dashboard_stats	bool	false	Allow merchant to see dashboard stats
allow_file_batch	bool	false	Allow merchant to access our file batch upload
allow_automatic_account_updater	bool	false	Allow merchant to access our account updater
allow_surcharge	bool	false	Allow merchant to use surcharge
allow_midigator	bool	false	Allow merchant to use our Midigator integration
allow_advanced_rule_engine_features	bool	false	Allow merchant to access our advanced rule engine features
allow_dual_pricing	bool	false	Allow merchant to use Dual Pricing (recommend v2 below)
allow_terminal_credits	bool	false	Allow merchant to process blind credits on terminals
enforce_2fa_requirement	bool	false	Requires merchant to have 2FA setup for processing Credits
allow_transaction_reporting_totals	bool	false	Allow merchant to use our Transaction Reporting Totals
allow_dual_pricing_v2	bool	false	Allow merchant to use Dual Pricing v2
allow_simple_payments_access	bool	false	Allow merchant access our Simple Payments Product
allow_virtual_terminal_session	bool	false	Allow merchant to access our Virtual Terminal Session management
require_2fa_for_user_access	bool	false	Requires all users on the merchant to setup 2FA to access the gateway via User/Password

Change merchant status

Request Method: GET

URL Endpoint: /api/merchant/{merchantid}/status/{status}

Name	Type	Default	Description	Required	Regex
merchantid	string		Merchants ID	true	([0-9a-v]{20})
status	string		Merchants Status	true	(active|disable)

Create new Processor

Request Method: POST

URL Endpoint: /api/merchant/{merchantid}/processor

Name	Type	Default	Description	Required	Regex
name	string		Merchants Name	true	([0-9a-z ]{1,100})
description	string		Merchant Description - internal description	true	([0-9a-z]{1,254})
status	string		Account Status	true	(active|disabled)
default_card	bool		Should we use this as the default card processor?
timezone	string		Timezone - EX America/Chicago	true
tag	string		Tag - used if you are looking to apply custom fraud rules
settle_at	string		Time to auto settle nightly. Only in 30min intervals.	true	HH:MM:00
payment_adj_type	string		"flat" or "percentage"	false
payment_adj_val	uint		uint assums 3 decimal places. 3000 = 3.000%	false
features	object	This object sets various feature flags on this processor	false
features.disable_auto_settle	bool	false	This can disable nightly auto settlement from ocurring	false
features.hide_in_vt	bool	false	This will hide this processor from appearing in the Virtual Terminal	false
supported_currencies	[]string		This should contain an array of currency codes, for example "usd", if this is not provided we will default to all currencies the processor supports	false	([a-z]{3})
ruleset	[]string		This should contain an array of ruleset IDs	false
settings	object		Settings Container
settings.tsys_sierra	object		Settings related to TSYS var sheet
limits	object		Limits Container
limits.sale	object		Limit settings for Sale/Authorization transactions
limits.sale.single	uint	0	Single transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit
limits.sale.daily	uint	0	Daily transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit. Based of of current day in UTC
limits.sale.monthly	uint	0	Monthly transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit. Based of of current day in UTC
limits.credit	object		Limit settings for Credit transactions
limits.credit.single	uint	0	Single transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit
limits.credit.daily	uint	0	Daily transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit. Based of of current day in UTC
limits.credit.monthly	uint	0	Monthly transaction limit in lowest unit for currency. $1.00 = 100. 0 indicates no limit. Based of of current day in UTC

Create New User for Merchant

Request Method: POST

URL Endpoint: /api/merchant/{merchantid}/user

Name	Type	Default	Description	Required	Regex
username	string		Primary user account to create	true	([a-zA-Z][a-zA-Z_0-9.]{6,50})
name	string		Users display name	true	([0-9a-z \w]{1,100})
phone	string		Phone - digits only	true	([0-9]{10})
email	string		Users email address	true
timezone	string		Timezone - EX America/Chicago	true
status	string		Users status	true	(active|disabled)
role	string		Primary users role, should always be admin	true	(admin|standard)
send_welcome	bool	false	Toggle to send a welcome email
create_api_key	bool	false	Toggle to create the private api key and return it
create_pub_api_key	bool	false	Toggle to create the public api key and return it
permissions	object	Use defaults	See below for available permissions. Defaults to false for any not provided.

Available Permissions:

Name	Type	Default	Description
support_blind_credits	bool	false	Allow merchant to process blind credits
allow_rule_engine_access	bool	false	Allow merchant to use our fraud rules
allow_invoice_access	bool	false	Allow merchant to use invoicing
allow_customer_vault_access	bool	false	Allow merchant to use customer vault
allow_recurring_billing_access	bool	false	Allow merchant to use recurring billing
allow_cart_access	bool	false	Allow merchant to use our hosted cart
allow_developer_hub_link	bool	false	Allow merchant to see our developer hub link
allow_advanced_fields	bool	false	Allow merchant to pass advanced fields for Level 3
enable_terminal_debit_transactions	bool	false	Allow merchant to process debit transactions on terminals
allow_defaults_population	bool	false	Allow merchant to use L3 auto population
allow_billing_access	bool	false	Allow merchant to see billing reports, if set up as bill Merchant
allow_dashboard_stats	bool	false	Allow merchant to see dashboard stats
allow_file_batch	bool	false	Allow merchant to access our file batch upload
allow_automatic_account_updater	bool	false	Allow merchant to access our account updater
allow_surcharge	bool	false	Allow merchant to use surcharge
allow_midigator	bool	false	Allow merchant to use our Midigator integration
allow_advanced_rule_engine_features	bool	false	Allow access to our advanced rule engine features
allow_dual_pricing	bool	false	Allow merchant to use Dual Pricing (recommend v2 below)
allow_terminal_credits	bool	false	Allow merchant to process blind credits on terminals
enforce_2fa_requirement	bool	false	Requires merchant to have 2FA setup for processing Credits
allow_transaction_reporting_totals	bool	false	Allow merchant to use our Transaction Reporting Totals
allow_dual_pricing_v2	bool	false	Allow merchant to use Dual Pricing v2
allow_simple_payments_access	bool	false	Allow merchant access to our Simple Payments Product
allow_virtual_terminal_session	bool	false	Allow merchant to access our Virtual Terminal Session management
require_2fa_for_user_access	bool	false	Requires all users to setup 2FA to access the gateway via User/Password

Appendix

Supported Timezones

Name
UTC
US/Alaska
US/Aleutian
US/Arizona
US/Central
US/Eastern
US/East-Indiana
US/Hawaii
US/Indiana-Starke
US/Michigan
US/Mountain
US/Pacific
US/Samoa