Management API

Base Resource URL:


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

Description:

Provides access to resellers registered in the system

Available sub-resources:

Resource URL	Description
https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]	Reseller code of a reseller, on which action is required. In cases when an external identifier (Reference Number) is desired to be used in place of Reseller Code, the star () must be used, followed by the external identifier assigned to the reseller. For example, /resellers/1.xml - reseller identification is done using Reseller Code, in this case 1 /resellers/004.xml - reseller identification is done using Reference Number, in this case 004

Resource URL

Description

https://sandbox-portal.tidypay.com/api/v01/resellers/[reseller-code]

Reseller code of a reseller, on which action is required.

In cases when an external identifier (Reference Number) is desired to be used in place of Reseller Code, the star (*) must be used, followed by the external identifier assigned to the reseller.

For example,

/resellers/1.xml - reseller identification is done using Reseller Code, in this case 1

/resellers/*004.xml - reseller identification is done using Reference Number, in this case 004

Supported Actions:

create

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

Creates Reseller with default reseller code.

Parameters:

#	Name	Type	Required	Default	Description
01	userName	String	No		User that will have access to the reseller.
02	reseller	Reseller *	Yes		Reseller parameters. Represents reseller object without sub-components.
03	notificationPolicy	Reseller	No	default	If the "default" value is used, the email notification upon reseller creation will be sent out to creator. Represents reseller object without sub-components.

find

Method: GET	Implicit: Yes	Returns: Reseller[] *
Consumes: xurl		Produces: json, xml

Returns list of available resellers 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	сreateDate.from	Date	No		Query parameter to search resellers by their creation date. All resellers created within the date range defined will be included.
04	сreateDate.to	Date	No		Query parameter to search resellers by their creation date. All resellers created within the date range defined will be included.
05	resellerName	String(255)	No		Query parameter to search resellers by full name (soundex on full name is supported as well).
06	code	Integer	No		Query parameter to search resellers by code.
07	id	Integer	No		Query parameter to search resellers by id.
08	active	Boolean	No		Query parameter to search resellers by activity status.

load

Method: GET	Implicit: Yes	Returns: Reseller *
Consumes: xurl		Produces: json, xml

Returns reseller based on specified code.

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