Management API

Base Resource URL:

     https://manager-stage.pepgate.com/api/v01/customers

Description:

Provides access to customers registered within the system.

Available sub-resources:

Resource URL Description
https://manager-stage.pepgate.com/api/v01/customers/[customer-id]    Provides access to configuration settings for the specified customer.

Supported Actions:

create  
Method:  PUT       Implicit:  Yes       Returns:  Customer *      
Consumes:  json, xml  Produces:  json, xml 
 
Creates a customer.

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

find  
Method:  GET       Implicit:  Yes       Returns:  Customer[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns a list of available customers 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 100 Maximum number of records to load per single search web call made by the customer.
03 accountId Integer No Identifier of the account within the gateway.
04 firstName String(125) No The first name of the customer.
05 lastName String(125) No The last name of the customer.
06 organizationName String(255) No Name of the organization associated with the customer.
07 email String(100) No Email address of the customer.
08 phone String(15) No Phone number of the customer.
09 street String(128) No Street address of the customer.
10 city String(50) No City of the customer.
11 state String(3) No State of the customer.
12 zipCode String(10) No ZIP or postal code of the customer.
13 countryCode String(2) No Country code of the customer's address.

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