Myntpay || Myntpay Gateway User's Manual

Management API

Base Resource URL:


			                            https://manager.pepgate.com/api/v01/customers/[customer-id]

Description:

Provides access to configuration settings for the specified customer.

Available sub-resources:

Resource URL	Description
https://manager.pepgate.com/api/v01/customers/[customer-id]/payment-options	Provides access to payment options associated with the specified customer.
https://manager.pepgate.com/api/v01/customers/[customer-id]/subscriptions	Allows to manage the subscriptions associated with the specified customer.
https://manager.pepgate.com/api/v01/customers/[customer-id]/transactions	Provides access to the transactions associated with the specified customer.

Supported Actions:

load

Method: GET	Implicit: Yes	Returns: Customer *
Consumes: query		Produces: json, xml

Returns configuration settings for the selected customer.

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.
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.

modify

Method: POST	Implicit: Yes	Returns: Customer *
Consumes: json, xml, query		Produces: json, xml

Updates the selected customer with the specified values.

Parameters:

#	Name	Type	Required	Default	Description
01	object	Customer *	Yes		Represents information about the customer.

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.