Management API

Base Resource URL:


                            https://[server-name]/api/v01/plans

Description:

Provides access to the pricing plans available within the system.

Available sub-resources:

Resource URL	Description
https://[server-name]/api/v01/plans/[plan-id]	Provides access to configuration settings for the selected pricing plan.

Supported Actions:

create

Method: PUT	Implicit: Yes	Returns: Plan *
Consumes: json, xml, query		Produces: json, xml, query

Creates a pricing plan.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Plan *	Yes		Represents information about the plan.

Response Codes: view

Code	HTTP Status Code	HTTP Status Code
S01	401	Invalid user name/password Either username/password was not supplied or the supplied credentials were not found in the system.
S04	404	Unsupported Operation Requested operation/action is not supported by the API.
S05	404	Object not found Requested merchant, merchant account or reseller is not registered in the system. Verify that the supplied code/reference code contains no errors.
S06	401	Object access denied Access to the merchant, merchant account or reseller is denied. Contact system administrator to verify permissions on your user account.
S07	404	Sub-merchant resource is not supported Specified resource is not supported by the API for sub-merchants.
S99	500	System error Runtime error occurred during service execution. Please try again later. If the error persists, contact system administrator.
V01	400	Invalid parameter format One (or more) of the parameter values is invalid. The value is out of the allowed range or is not properly formatted and thus cannot be parsed and processed.

find

Method: GET	Implicit: Yes	Returns: Plan[] *
Consumes: query		Produces: json, xml

Returns a list of available pricing plans based on specified search criteria.

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	20	Maximum number of records to load per single search web call made by the customer.
03	accountId	Integer	Yes		Unique internal identifier of the account associated with the pricing plan.
04	createDate	Date	No		Date when the pricing plan has been created.
05	amount	Integer	No		Amount of the pricing plan.
06	billingCycleType	Enum	No	M	Defines the frequency of the billing. Possible values: W - weekly M - monthly Q - quarterly S - semi-annually A - annually

Response Codes: view

Code	HTTP Status Code	HTTP Status Code
S01	401	Invalid user name/password Either username/password was not supplied or the supplied credentials were not found in the system.
S03	404	Resource unavailable Specified resource is not available, not found or is not supported by the API.
S05	404	Object not found Requested merchant, merchant account or reseller is not registered in the system. Verify that the supplied code/reference code contains no errors.
S06	401	Object access denied Access to the merchant, merchant account or reseller is denied. Contact system administrator to verify permissions on your user account.
S07	404	Sub-merchant resource is not supported Specified resource is not supported by the API for sub-merchants.
S99	500	System error Runtime error occurred during service execution. Please try again later. If the error persists, contact system administrator.
V01	400	Invalid parameter format One (or more) of the parameter values is invalid. The value is out of the allowed range or is not properly formatted and thus cannot be parsed and processed.

Copyright © United Thinkers. (UniPay - Payment Gateway Software)

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