Management API

Base Resource URL:


                    https://sandbox-portal.tidypay.com/api/v01/merchants

Description:

Provides access to merchants registered in the system

Available sub-resources:

Resource URL	Description
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-account-code]	Provides access to configuration settings of the selected account.
https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]	Merchant code of a merchant, on which action is required. In cases when an external identifier (Reference Code) is desired to be used in place of Merchant Code, the asterisk () must be used, followed by the external identifier assigned to the merchant. For example, /merchants/2000.xml - merchant identification is done using Merchant Code, in this case 2000 /merchants/888760.xml - merchant identification is done using Reference Number, in this case 888760 Note that both merchants and sub-merchants (merchant accounts) can be accessed in a uniform way through this resource. When new sub-merchant needs to be setup using Reference Number identification, use dot (.) to separate merchant identifier from sub-merchant identifier For example, /merchants/*888760.00001.xml - would provide access to a sub-merchant record with Reference Number 00001 under merchant record with Reference Number 888760. The merchant-sub-merchant combined Reference Number is only required when a new record is being setup. In all other cases, sub-merchant's Reference Number is sufficient for identification as long as it's unique on the system level. In cases, when it is not unique, use combined Reference Number.

Resource URL

Description

https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-account-code]

Provides access to configuration settings of the selected account.

https://sandbox-portal.tidypay.com/api/v01/merchants/[merchant-code]

Merchant code of a merchant, on which action is required.

In cases when an external identifier (Reference Code) is desired to be used in place of Merchant Code, the asterisk (*) must be used, followed by the external identifier assigned to the merchant.

For example,

/merchants/2000.xml - merchant identification is done using Merchant Code, in this case 2000

/merchants/*888760.xml - merchant identification is done using Reference Number, in this case 888760

Note that both merchants and sub-merchants (merchant accounts) can be accessed in a uniform way through this resource.

When new sub-merchant needs to be setup using Reference Number identification, use dot (.) to separate merchant identifier from sub-merchant identifier

For example,

/merchants/*888760.00001.xml - would provide access to a sub-merchant record with Reference Number 00001 under merchant record with Reference Number 888760.

The merchant-sub-merchant combined Reference Number is only required when a new record is being setup. In all other cases, sub-merchant's Reference Number is sufficient for identification as long as it's unique on the system level. In cases, when it is not unique, use combined Reference Number.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: Merchant *
Consumes: json, xml, xurl		Produces: json, xml, xurl

Creates Merchant with default merchant code.

Parameters:

#	Name	Type	Required	Default	Description
01	userName	String	No		User that will have access to the merchant.
02	merchant	Merchant *	Yes		Merchant parameters. Represents merchant object without sub-components
03	notificationPolicy	Merchant *	No	default	If the "default" value is used, the email notification upon merchant creation will be sent out to creator. Represents merchant object without sub-components
04	resetCache	Merchant *	No	true	Automatic clearing of cache while creating or modificating a new merchant or merchant account. If cache reset is not needed for new merchant or merchant account (for example, bulk import), set value to "false". If the value is set to true or not specified, the cache will be reset by default. Represents merchant object without sub-components
05	terminalSetup	String(20)	No		Allows to create one or more terminals while creating a merchant. Format of the parameter is the following: terminalSetup=from\|to\|{terminalClassifier-value}, where from - ID of the first terminal; to - ID of the last terminal; {terminalClassifier-value} - type of the terminal. There are four types of the terminal: POS - General POS. Indicates general POS terminal. AFP - Automated fuel pump. Indicates terminals associated with fuel stations. The client can pay for fuel by inserting a credit or debit card or a fuel card into a slot on the pump. KSK - Kiosk. Indicates an interactive kiosk (a computer terminal) for minor payments. VRT - Virtual. Indicates virtual terminal.
06	isFtpAccessRequired	Boolean	No	true	Allows to create an FTP folder while creating a merchant. Required to be set as true for batch processing.

find

Method: GET	Implicit: Yes	Returns: Merchant[] *
Consumes: not applicable		Produces: json, xml, xurl

Returns list of available merchants based on specified search conditions

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	createDate.from	Date	No		Query parameter to search merchants by their creation date. All merchants created within the date range defined will be included.
04	createDate.to	Date	No		Query parameter to search merchants by their creation date. All merchants created within the date range defined will be included.
05	merchantName	String(255)	No		Query parameter to search merchants by full name (soundex on full name is supported as well).
06	code	Integer	No		Query parameter to search merchants by code.
07	id	Integer	No		Query parameter to search merchants by id.
08	resellerCode	Integer	No		Query parameter to search merchants by reseller code.
09	active	Boolean	No		Query parameter to search merchants by activity status.
10	contactName	String(255)	No		Query parameter to search merchants by an associated contact name.

findByBusinessInfo

Method: GET	Implicit: Yes	Returns: Merchant[] *
Consumes: not applicable		Produces: json, xml, xurl

Returns list of available merchants based on specified business information.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	provisioningCode	Integer	No		Query parameter to search merchants by provisioning code.
04	federalTaxId	String(128)	No		Query parameter to search merchants by Federal Tax ID.
05	legalName	String(255)	No		Query parameter to search merchants by legal name of a particular company.
06	businessName	String(50)	No		Query parameter to search merchants by DBA name of a particular company.

findByProcessorInfo

Method: GET	Implicit: Yes	Returns: Merchant[] *
Consumes: not applicable		Produces: json, xml, xurl

Returns list of available merchants based on specified processor information.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	processorMid	Integer	No		Query parameter to search merchants by MID associated with a particular processor.

findByUserInfo

Method: GET	Implicit: Yes	Returns: Merchant[] *
Consumes: not applicable		Produces: json, xml, xurl

Returns list of available merchants based on specified user information.

Parameters:

#	Name	Type	Required	Default	Description
01	offset	Integer	No	0	Index of the first record returned to the customer from the search result of a web search.
02	limit	Integer	No	100	Maximum number of records to load per single search web call made by the customer.
03	email	String(100)	No		Query parameter to search merchants by an email associated with a particular user account.

All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.