Register Method

The register method can be used to onboard a potential merchant, and all of the required information about the merchant, onto the system. This method doesn’t create a merchant record immediately. Instead, it stores the record under merchant registrations for further processing.

Request Fields

FieldName	Mandatory?	Field Type	Description	Sample
RegistrationData	No		This block contains data about the merchant
UserName	No		The username for the merchant - will be used to create the account login.	John.Smith
Email	No	String	Merchant's email address	John.Smith@home.com
Password	No	String	This will be the merchant's password to login to the MCP and services - if not sent a temp password will be create when "Auto-create" merchant if set.	Password123!
ParentCompany	No	Int	The ID of the parent company you wish to register the merchant under - this will be taken from the Admin portal - remember you have to set the "Auto-create" merchant to true	ACME
Address	No	String	Merchant's juridical address	14 Arbour Road
BankAccountNumber	No	String	Merchant's bank account number	6251234567890
BankRoutingNumber	No	String	The account routing number.	78523
BusinessDescription	No	String	Merchant's business description	Groceries
BusinessStartDate	No	dateTime	Date when the merchant's business was founded	25/09/2018
CanceledCheckImage	No	Base64Binary	In some cases registration process require a prof of address or a prof of banking details - use use this field to upload the necessary file.
City	No	String	Merchant's juridical city	Jhb
DbaName	No	String	Doing Business As name - Brand name	Johns Groceries
Fax	No	String	Merchant's fax number	27115551235
FirstName	No	String	Merchant's first name	John
Industry	No	Int	Merchant's industry. Should be chosen from the provided list	Food
LastName	No	String	Merchant's last name	Smith
LegalBusinessName	No	String	Merchant's legal business name	Johns Groceries
LegalBusinessNumber	No	String	Merchant's legal business number	76543
OwnerDob	No	dateTime	Date of birth of the company's owner	25/09/1990
OwnerSsn	No	String	The business owner personal ID number or Social Security Number.	90092512345
PhisicalAddress	No	String	Merchant's physical address	14 Arbour Road
PhisicalCity	No	String	Merchant's physical city	Jhb
PhisicalState	No	String	Merchant's physical state	Gauteng
PhisicalZip	No	String	Merchant's physical postal code	2195
Phone	No	String	Merchant's phone number	0115551234
State	No	String	Merchant's juridical state	Gauteng
StateOfIncorporation	No	String	The state in which the company was incorporated.	Gauteng
TypeOfBusiness	No	Int	Merchant's type of business. Should be chosen from the provided list	Food
IndustryDataID	No	String	The industry the user belongs to, a more general approach then SetPosition which includes all of the Job history for the user.	5500
Url	No	String	Merchant's website URL	www.johnsgroceries.biz
Zipcode	No	String	Merchant's juridical postal code	2195
UBO1FirstName	No	String	UBO first name	John
UBO1LastName	No	String	UBO last name	Smith
UBO1DOB	No	DateTime	UBO date of birth	25/09/1990
UBO1Address1	No	String	UBO address line 1	14 Arbour Road
UBO1Address2	No	String	UBO address line 2
UBO1Zip	No	String	UBO address ZIP	2195
UBO1City	No	String	UBO address City	Jhb
UBO1Country	No	String	UBO address Country	South Africa
UBO1Phone	No	String	UBO Phone number	0115551234
UBO1PassportID	No	String	UBO Passport or ID	90092512345
UBO1SSN	No	String	UBO Social Security Number (US)
AnticipatedAverageTransactionAmount	No	Decimal	Anticipated average transaction amount	100
AnticipatedLargestTransactionAmount	No	Decimal	Anticipated largest transaction amount	1500
AnticipatedMonthlyVolume	No	Decimal	Anticipated monthly volume	15000
PercentDelivery0to7	No	Int	What is the percentage of goods to be delivered to client within 7 days	100
PercentDelivery15to30	No	Int	What is the percentage of goods to be delivered to client within 15 to 30 days	0
PercentDelivery8to14	No	Int	What is the percentage of goods to be delivered to client within 8 to 14 days	0
PercentDeliveryOver30	No	Int	What is the percentage of goods to be delivered to client after more than 30 days.	0
M1NumberOfTransactions	No	Decimal	Number of transaction the last month (Count)	150
M1TransactionVolume	No	Decimal	Total amount processed the last month	150
M1NumberOfChargeBack	No	Decimal	Number of Chargebacks the last month (Count)	0
M1ChargebackVolume	No	Decimal	Total amount of refunds processed the last month	0
M1NumberOfRefunds	No	Decimal	Number of Refunds the last month (Count)	2
M1RefundVolume	No	Decimal	Total amount of chargebacks processed the last month	0
CurrentPreviousProvider	No	String	Current/Previous PSP or Gateway used	None
CurrentPreviousAcquirer	No	String	Current/Previous Acquirer used	None
ReasonsForLeavingAcquirer	No	String	Please describe the reason for leaving your previous provider.	First Provider
OOTDomestic	No	Decimal	Origin Of Transaction - Domestic - from the country of the merchant	South Africa
OOTEurope	No	Decimal	Origin Of Transaction - Europe	N/A
OOTUSA	No	Decimal	Origin Of Transaction - USA	N/A
OOTAsia	No	Decimal	Origin Of Transaction - Asia	N/A
OOTROW	No	Decimal	Origin Of Transaction - Rest Of the World	N/A
TechFirstName	No	Decimal	Technical contact first name	Joe
TechLastName	No	Decimal	Technical contact last name	Smith
TechEmail	No	Decimal	Technical contact Email address	joe@johnsgroceries.biz
TechPhone	No	Decimal	Technical contact Phone number	27115551236
FinanceFirstName	No	Decimal	Finance contact first name	Jen
FinanceLastName	No	Decimal	Finance contact last name	Smith
FinanceEmail	No	Decimal	Finance contact Email address	jen@johnsgroceries.biz
FinancePhone	No	Decimal	Finance contact Phone number	27115551237
RiskFirstName	No	Decimal	Risk contact first name	Jeff
RiskLastName	No	Decimal	Risk contact last name	Smith
RiskEmail	No	Decimal	Risk contact Email address	jeff@johnsgroceries.biz
RiskPhone	No	Decimal	Risk contact Phone number	27115551238

Response Fields

Field	Name Field	Type Description
This method is void and has an empty response body

AddNewMerchant Method

The AddNewMerchant method registers the Merchant within the gateway. The merchant will be associated with the relevant Partner as specified by the PartnerID.

Request Fields

FieldName	Mandatory?	Field Type	Description	Sample
LegalBusinessName	Yes	string	Merchant Business Name	Johns Groceries
PhysicalAddress	Yes	string	Merchant Physical Address	14 Arbour Road
FirstName	Yes	String	Contact First Name	John
LastName	Yes	String	Contact Last Name	Smith
Phone	Yes	String	Telephone Number	27115551235
MerchantEmail	Yes	String	Merchant Contact Email	John.Smith@johnsgroceries.biz
Url	Yes	String	Merchant Url	www.johnsgroceries.biz
CountryIsoCode	Yes	String	Registered Business Country	ZA
CurrencyIsoCode	Yes	string	Currency Code ISO4217*	ZAR
PartnerID	Yes	Int	Partner ID Associated with the Merchant	12345

UpdateMerchant Method

Update any of the merchants’ details within the system.

Request Fields

FieldName		Mandatory?	Field Type	Description	Sample
LegalBusinessName		Yes	String	Merchant Business Name	Johns Groceries
PhysicalAddress		Yes	String	Merchant Physical Address	14 Arbour Road
FirstName		Yes	String	Contact First Name	John
LastName		Yes	String	Contact Last Name	Smith
Phone		Yes	String	Telephone Number	27115551235
MerchantEmail		Yes	String	Merchant Contact Email	John.Smith@johnsgroceries.biz
Url		Yes	String	Merchant Url	www.johnsgroceries.biz
CountryIsoCode		Yes	String	Registered Business Country	ZA
CurrencyIsoCode		Yes	string	Currency Code ISO4217*	ZAR
MerchantID		Yes	Int	Merchant ID	54321

Response Fields

Field Name	Field Type	Description
IsSuccess	Boolean	Defines whether service call was processed successfully or not
Message	String	Result message
MerchantID	Int	Merchant ID

UpdateMerchantStatus Method

This method is used specifically for setting the status of a merchant. Setting the StatusID to Active (30) will return the required Hashkey needed for use on the production environment.

Request Fields

FieldName	Mandatory?	Field Type	Description	Sample
MerchantID	Yes	int	Merchant ID	54321
StatusID	Yes	int	Status ID	30

Status Table

StatusID	Description	Action
1	New	Registered account. Vetting to take place.
10	Awaiting Activation	Account vetting in progress
30	Active	Fully operational account.
40	InActive	Temporary suspension of processing ability
2	Blocked	Account is blocked from transacting
99	Deleted	Account to be deleted from the system completely

Response Fields

Field Name	Field Type	Description
IsSuccess	Boolean	True means successfully stored
Message	string	Message description for failed or successful messages
Hashkey	string	Hashkey returned once Merchant Status Set to 30
LiveUrl	string	The URL returned

GetMerchant Method

Returns the stored data for a merchant.

Request Fields

FieldName		Mandatory?	Field Type	Description	Sample
LegalBusinessName		Yes	String	Merchant Business Name	Johns Groceries
PhysicalAddress		Yes	String	Merchant Physical Address	14 Arbour Road
FirstName		Yes	String	Contact First Name	John
LastName		Yes	String	Contact Last Name	Smith
Phone		Yes	String	Telephone Number	27115551235
MerchantEmail		Yes	String	Merchant Contact Email	John.Smith@johnsgroceries.biz
Url		Yes	String	Merchant Url	www.johnsgroceries.biz
CountryIsoCode		Yes	String	Registered Business Country	ZA
CurrencyIsoCode		Yes	String	Currency Code ISO4217*	ZAR
PartnerID		Yes	Int	Partner ID	12345
merchantID		Yes	Int	Merchant ID	54321
StatusID		Yes	Int	Status of the Merchant	30

Response Fields

Field Name	Field Type	Description
MerchantID	int	Merchant ID
StatusID	int	*See status table

ListMerchantStatus Method

Returns a list of merchants and their corresponding status for a specified Partner (PartnerID).

Request Fields

Parameter	Mandatory	Type	Description
MerchantID	Yes	int	Merchant ID

Response Fields

Field Name	Field Type	Description
Code	Integer
IsSuccess	Boolean
Key	String
Message	String	See Return Codes Table*
Number	String