Payment Methods - API Reference

Payment Methods

The available payment methods at checkout. An order can only have 1 payment method, but the admin can change the payment method, and take part payments.

End Point URL

https://api.cms-tool.net/webapps/api/paymentop

Data Dictionary

Key	Definition	Type	Format
cid	Website ID System variable for website association	int	e.g. 123456
pay_api_type_id	Accounting API GUID Peculiar to some accounting systems, will use this to sync the payment record to an order after payment received.	text
paymentop_config	Additional Config Additional Config in JSON format.	text
payopaccount	API Credential Key Primary credtential user ID or key for connecting to a payment gateway	text
payop_allow_cancellations	Allow cancellations Allow users to cancel their order within this period of time. Otherwise, only a merchant can cancel	interval	e.g. 01:00:00
payop_api_gl_account	GL Account When syncing payment to a third party accounting system, use this GL code for payments	text
payop_auto_cancellations	Auto Cancellation Timeout Auto cancel after this period of time if the user has not paid in order to release stock	interval	e.g. 01:00:00
payop_auto_paid_status	Auto Paid Status Automatically mark order as paid if paying by this method, eg for customers who have trade accounts.	bool	true/false
payopbatched	Batching If daily transactions are batched	bool	true/false
payop_changeable	Method Changeable Can the payment method be changed to another method after purchase... By default true	bool	true/false
payopcurrency	Currency Currency if limited to a specific currency	char
payopdepositpercent	Deposit Percentage If using this payment method, the customer only needs to pay a deposit of this amount.	decimal	Precision: 5.1
payopdetailafter	payopdetailafter Additional detail to provide to customer after they have chosen the method, eg bank address.	text
payopdetailbefore	Description For User A description of this payment method presented to the user when considering which payment option to choose	text
payop_extra1	API Additional Field 1 Credtential or setup field - depends on payment method	text
payop_extra2	API Additional Field 2 Credtential or setup field - depends on payment method	text
payophashcode	API Credential Secret Secret credential for accessing a payment gateway	text
payop_icon_personalised	Icon Personalised ICON Image for use on template footer payment methods accepted gallery	text
payopid	ID Primary ID of the payment method.	Integer (Unique ID)	e.g. 123456
payop_ifall_categoryid	Category Filter If All If all products are in this category, then the option is available	int
payop_if_map_filter	Country Filter Only supported in a specific country related to the delivery country.	int
payopinstallmentinterval	Installmen Interval Installmen Interval when deposits and post payments required	interval	e.g. 01:00:00
payopinstallmentpercent	Installment percent Installment percent when using deposits and post payments required	decimal	Precision: 5.1
payoplogo	Logo Image Alternative logo to use for this payment methods	text
payopmaxvalue	Maximum Spend Requirement Maximum value of transaction for which this payment method is valid	decimal	Precision: 12.2
payopmbrgroupid	Customer Group Filter Limit use to customers from member group ID	int
payopmbrlevel	Customer Security Level Customer Security Level	int
payopmbrlevelmax	Customer Security Level Maximum Use this to hide a retail payment offer from your trade customers	int
payopminvalue	Minimum Spend Requirement Minimum spend before this method is available to use	decimal	Precision: 10.2
payopnosendorder	No Send Order Email If true, do not send the order email to the customer, rather wait for the order to be paid	char
payopnosendordermerchant	No Send Merchant Order Email If true, do not send a order copy to the merchant to avoid noise	char
payopnosendreceipt	No Send Receipt If true, do not send a receipt, why i do not know	char
payopnosendreceiptmerchant	No Send Merchant Receipt If true, do not send a receipt copy to the merchant to avoid noise	char
payop_notifany_categoryid	Category Filter Not If Any This payment method is not available if any product is in this category ID	int
payop_notif_map_filter	Country Filter Not If Not supported in this country or region ID	int
payoppage	Page ID If limited to a specific shopping page, then this is the page ID of that page, otherwise 0 for all pages	int
payoppriority	List Order A sorting number from 1 upwards, as to which order to display payment options to user	int
payop_remind_unpaid_carts	Remind unpaid carts Send Unpaid Order Reminder after this interval if unpaid	interval	e.g. 01:00:00
payop_rounding	Rounding amount Rounding would equal 0.10 if rounding to 10 cents	decimal	Precision: 10.2
payopshowmbrid	payopshowmbrid If T, then show the customer ID on the final screen	char
payopsubacc	API Sub Account Additional account reference to be used along side API credentials when the API offers multiple sub accounts	text
payopsubscriptionenabled	Save Card Enabled True if offering to save card details or for subscriptions where payment repeats without card present.	bool	true/false
payoptestcode	Payment Test Mode Typically single char = T if operating in test mode against a test server with test credentials	text
payoptitlebefore	Title For Customer A user friendly title for this payment option	text
payoptransfee	Transaction Fee Fixed A fixed transaction fee for using this payment option, eg 50c	decimal	Precision: 10.2
payoptransfeepc	Transaction Fee Percent A percentage transaction fee for using this payment option, eg 2% = 0.02	decimal	Precision: 10.2
payoptype	Payment Type The type of payment option, foreign key to the list of available payment options.	text