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 | |
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 |
Field | Name Field | Type Description |
---|---|---|
This method is void and has an empty response body |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/Register"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{rn "RegistrationData": {rn "Email": "string",rn "UserName": "string",rn "Password": "string", //Optional - if not sent a temp password will be created and sent via emailrn "ParentCompany": int, //in order to auto create merchant the ParentCompany id must be set and configured on the admin sidern "Address": "string",rn "AnticipatedAverageTransactionAmount": decimal,rn "AnticipatedLargestTransactionAmount": decimal,rn "AnticipatedMonthlyVolume": decimal,rn "BankAccountNumber": "string",rn "BankRoutingNumber": "string",rn "BusinessDescription": "string",rn "BusinessStartDate": dateTime,rn "CanceledCheckImage": base64Binary,rn "City": "string",rn "DbaName": "string",rn "Fax": "string",rn "FirstName": "string",rn "Industry": int,rn "LastName": "string",rn "LegalBusinessName": "string",rn "LegalBusinessNumber": "string",rn "OwnerDob": dateTime,rn "OwnerSsn": "string",rn "PercentDelivery0to7": int,rn "PercentDelivery15to30": int,rn "PercentDelivery8to14": int,rn "PercentDeliveryOver30": int,rn "PhysicalAddress": "string",rn "PhysicalCity": "string",rn "PhysicalState": "string",rn "PhysicalZip": "string",rn "Phone": "string",rn "State": "string",rn "StateOfIncorporation": "string",rn "TypeOfBusiness": int,rn "Url": "string",rn "Zipcode": "string",rn "UBO1FirstName": "string",rn "UBO1LastName": "string",rn "UBO1DOB": dateTime,rn "UBO1Address1": "string",rn "UBO1Address2": "string",rn "UBO1Zip": "string",rn "UBO1City": "string",rn "UBO1Country": "string",rn "UBO1Phone": "string",rn "UBO1PassportID": "string",rn "UBO1SSN": "string",rn "UBO2FirstName": "string",rn "UBO2LastName": "string",rn "UBO2DOB": dateTime,rn "UBO2Address1": "string",rn "UBO2Address2": "string",rn "UBO2Zip": "string",rn "UBO2City": "string",rn "UBO2Country": "string",rn "UBO2Phone": "string",rn "UBO2PassportID": "string",rn "UBO2SSN": "string",rn "UBO3FirstName": "string",rn "UBO3LastName": "string",rn "UBO3DOB": dateTime,rn "UBO3Address1": "string",rn "UBO3Address2": "string",rn "UBO3Zip": "string",rn "UBO3City": "string",rn "UBO3Country": "string",rn "UBO3Phone": "string",rn "UBO3PassportID": "string",rn "UBO3SSN": "string",rn "UBO4FirstName": "string",rn "UBO4LastName": "string",rn "UBO4DOB": dateTime,rn "UBO4Address1": "string",rn "UBO4Address2": "string",rn "UBO4Zip": "string",rn "UBO4City": "string",rn "UBO4Country": "string",rn "UBO4Phone": "string",rn "UBO4PassportID": "string",rn "UBO4SSN": "string",rn "M1NumberOfTransactions": decimal,rn "M1TransactionVolume": decimal,rn "M1NumberOfChargeBack": decimal,rn "M1ChargebackVolume": decimal,rn "M1NumberOfRefunds": decimal,rn "M1RefundVolume": decimal,rn "CurrentPreviousProvider": "string",rn "CurrentPreviousAcquirer": "string",rn "ReasonsForLeavingAcquirer": "string",rn "OOTDomestic": decimal,rn "OOTEurope": decimal,rn "OOTUSA": decimal,rn "OOTAsia": decimal,rn "OOTROW": decimal,rn "TechFirstName": "string",rn "TechLastName": "string",rn "TechEmail": "string",rn "TechPhone": decimal,rn "FinanceFirstName": "string",rn "FinanceLastName": "string",rn "FinanceEmail": "string",rn "FinancePhone": decimal,rn "RiskFirstName": "string",rn "RiskLastName": "string",rn "RiskEmail": "string",rn "RiskPhone": decimal,rn rn }rn}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/Register", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": "{rn "RegistrationData": {rn "Email": "string",rn "UserName": "string",rn "Password": "string", //Optional - if not sent a temp password will be created and sent via emailrn "ParentCompany": int, //in order to auto create merchant the ParentCompany id must be set and configured on the admin sidern "Address": "string",rn "AnticipatedAverageTransactionAmount": decimal,rn "AnticipatedLargestTransactionAmount": decimal,rn "AnticipatedMonthlyVolume": decimal,rn "BankAccountNumber": "string",rn "BankRoutingNumber": "string",rn "BusinessDescription": "string",rn "BusinessStartDate": dateTime,rn "CanceledCheckImage": base64Binary,rn "City": "string",rn "DbaName": "string",rn "Fax": "string",rn "FirstName": "string",rn "Industry": int,rn "LastName": "string",rn "LegalBusinessName": "string",rn "LegalBusinessNumber": "string",rn "OwnerDob": dateTime,rn "OwnerSsn": "string",rn "PercentDelivery0to7": int,rn "PercentDelivery15to30": int,rn "PercentDelivery8to14": int,rn "PercentDeliveryOver30": int,rn "PhysicalAddress": "string",rn "PhysicalCity": "string",rn "PhysicalState": "string",rn "PhysicalZip": "string",rn "Phone": "string",rn "State": "string",rn "StateOfIncorporation": "string",rn "TypeOfBusiness": int,rn "Url": "string",rn "Zipcode": "string",rn "UBO1FirstName": "string",rn "UBO1LastName": "string",rn "UBO1DOB": dateTime,rn "UBO1Address1": "string",rn "UBO1Address2": "string",rn "UBO1Zip": "string",rn "UBO1City": "string",rn "UBO1Country": "string",rn "UBO1Phone": "string",rn "UBO1PassportID": "string",rn "UBO1SSN": "string",rn "UBO2FirstName": "string",rn "UBO2LastName": "string",rn "UBO2DOB": dateTime,rn "UBO2Address1": "string",rn "UBO2Address2": "string",rn "UBO2Zip": "string",rn "UBO2City": "string",rn "UBO2Country": "string",rn "UBO2Phone": "string",rn "UBO2PassportID": "string",rn "UBO2SSN": "string",rn "UBO3FirstName": "string",rn "UBO3LastName": "string",rn "UBO3DOB": dateTime,rn "UBO3Address1": "string",rn "UBO3Address2": "string",rn "UBO3Zip": "string",rn "UBO3City": "string",rn "UBO3Country": "string",rn "UBO3Phone": "string",rn "UBO3PassportID": "string",rn "UBO3SSN": "string",rn "UBO4FirstName": "string",rn "UBO4LastName": "string",rn "UBO4DOB": dateTime,rn "UBO4Address1": "string",rn "UBO4Address2": "string",rn "UBO4Zip": "string",rn "UBO4City": "string",rn "UBO4Country": "string",rn "UBO4Phone": "string",rn "UBO4PassportID": "string",rn "UBO4SSN": "string",rn "M1NumberOfTransactions": decimal,rn "M1TransactionVolume": decimal,rn "M1NumberOfChargeBack": decimal,rn "M1ChargebackVolume": decimal,rn "M1NumberOfRefunds": decimal,rn "M1RefundVolume": decimal,rn "CurrentPreviousProvider": "string",rn "CurrentPreviousAcquirer": "string",rn "ReasonsForLeavingAcquirer": "string",rn "OOTDomestic": decimal,rn "OOTEurope": decimal,rn "OOTUSA": decimal,rn "OOTAsia": decimal,rn "OOTROW": decimal,rn "TechFirstName": "string",rn "TechLastName": "string",rn "TechEmail": "string",rn "TechPhone": decimal,rn "FinanceFirstName": "string",rn "FinanceLastName": "string",rn "FinanceEmail": "string",rn "FinancePhone": decimal,rn "RiskFirstName": "string",rn "RiskLastName": "string",rn "RiskEmail": "string",rn "RiskPhone": decimal,rn rn }rn}", }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/Register", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{rn "RegistrationData": {rn "Email": "string",rn "UserName": "string",rn "Password": "string", //Optional - if not sent a temp password will be created and sent via emailrn "ParentCompany": int, //in order to auto create merchant the ParentCompany id must be set and configured on the admin sidern "Address": "string",rn "AnticipatedAverageTransactionAmount": decimal,rn "AnticipatedLargestTransactionAmount": decimal,rn "AnticipatedMonthlyVolume": decimal,rn "BankAccountNumber": "string",rn "BankRoutingNumber": "string",rn "BusinessDescription": "string",rn "BusinessStartDate": dateTime,rn "CanceledCheckImage": base64Binary,rn "City": "string",rn "DbaName": "string",rn "Fax": "string",rn "FirstName": "string",rn "Industry": int,rn "LastName": "string",rn "LegalBusinessName": "string",rn "LegalBusinessNumber": "string",rn "OwnerDob": dateTime,rn "OwnerSsn": "string",rn "PercentDelivery0to7": int,rn "PercentDelivery15to30": int,rn "PercentDelivery8to14": int,rn "PercentDeliveryOver30": int,rn "PhysicalAddress": "string",rn "PhysicalCity": "string",rn "PhysicalState": "string",rn "PhysicalZip": "string",rn "Phone": "string",rn "State": "string",rn "StateOfIncorporation": "string",rn "TypeOfBusiness": int,rn "Url": "string",rn "Zipcode": "string",rn "UBO1FirstName": "string",rn "UBO1LastName": "string",rn "UBO1DOB": dateTime,rn "UBO1Address1": "string",rn "UBO1Address2": "string",rn "UBO1Zip": "string",rn "UBO1City": "string",rn "UBO1Country": "string",rn "UBO1Phone": "string",rn "UBO1PassportID": "string",rn "UBO1SSN": "string",rn "UBO2FirstName": "string",rn "UBO2LastName": "string",rn "UBO2DOB": dateTime,rn "UBO2Address1": "string",rn "UBO2Address2": "string",rn "UBO2Zip": "string",rn "UBO2City": "string",rn "UBO2Country": "string",rn "UBO2Phone": "string",rn "UBO2PassportID": "string",rn "UBO2SSN": "string",rn "UBO3FirstName": "string",rn "UBO3LastName": "string",rn "UBO3DOB": dateTime,rn "UBO3Address1": "string",rn "UBO3Address2": "string",rn "UBO3Zip": "string",rn "UBO3City": "string",rn "UBO3Country": "string",rn "UBO3Phone": "string",rn "UBO3PassportID": "string",rn "UBO3SSN": "string",rn "UBO4FirstName": "string",rn "UBO4LastName": "string",rn "UBO4DOB": dateTime,rn "UBO4Address1": "string",rn "UBO4Address2": "string",rn "UBO4Zip": "string",rn "UBO4City": "string",rn "UBO4Country": "string",rn "UBO4Phone": "string",rn "UBO4PassportID": "string",rn "UBO4SSN": "string",rn "M1NumberOfTransactions": decimal,rn "M1TransactionVolume": decimal,rn "M1NumberOfChargeBack": decimal,rn "M1ChargebackVolume": decimal,rn "M1NumberOfRefunds": decimal,rn "M1RefundVolume": decimal,rn "CurrentPreviousProvider": "string",rn "CurrentPreviousAcquirer": "string",rn "ReasonsForLeavingAcquirer": "string",rn "OOTDomestic": decimal,rn "OOTEurope": decimal,rn "OOTUSA": decimal,rn "OOTAsia": decimal,rn "OOTROW": decimal,rn "TechFirstName": "string",rn "TechLastName": "string",rn "TechEmail": "string",rn "TechPhone": decimal,rn "FinanceFirstName": "string",rn "FinanceLastName": "string",rn "FinanceEmail": "string",rn "FinancePhone": decimal,rn "RiskFirstName": "string",rn "RiskLastName": "string",rn "RiskEmail": "string",rn "RiskPhone": decimal,rn rn }rn}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
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 |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/AddNewMerchant"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{"LegalBusinessName":"Hello World","PhysicalAddress":"test","FirstName":"Hello","LastName":"Muyambiri","Phone":"4145147859","MerchantEmail":"test4523ERE3@gmail.com","Url":"45789655","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","PartnerID":"2078"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/AddNewMerchant", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"LegalBusinessName":"Hello World","PhysicalAddress":"test","FirstName":"Hello","LastName":"Muyambiri","Phone":"4145147859","MerchantEmail":"test4523ERE3@gmail.com","Url":"45789655","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","PartnerID":"2078"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/AddNewMerchant", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{"LegalBusinessName":"Hello World","PhysicalAddress":"test","FirstName":"Hello","LastName":"Muyambiri","Phone":"4145147859","MerchantEmail":"test4523ERE3@gmail.com","Url":"45789655","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","PartnerID":"2078"}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
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 |
Field Name | Field Type | Description |
---|---|---|
IsSuccess | Boolean | Defines whether service call was processed successfully or not |
Message | String | Result message |
MerchantID | Int | Merchant ID |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchant"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{"LegalBusinessName":"Test Merchant ","PhysicalAddress":"42 Main Street, JHB, 2192","FirstName":"Henry","LastName":"Clever","Phone":"+27 11 888 1650","MerchantEmail":"user55656@email.com","Url":"www.pink-fish.co.uk","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","MerchantID":"2378148"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchant", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"LegalBusinessName":"Test Merchant ","PhysicalAddress":"42 Main Street, JHB, 2192","FirstName":"Henry","LastName":"Clever","Phone":"+27 11 888 1650","MerchantEmail":"user55656@email.com","Url":"www.pink-fish.co.uk","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","MerchantID":"2378148"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchant", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{"LegalBusinessName":"Test Merchant ","PhysicalAddress":"42 Main Street, JHB, 2192","FirstName":"Henry","LastName":"Clever","Phone":"+27 11 888 1650","MerchantEmail":"user55656@email.com","Url":"www.pink-fish.co.uk","CurrencyIsoCode":"GBP","CountryIsoCode":"GB","MerchantID":"2378148"}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
FieldName | Mandatory? | Field Type | Description | Sample |
---|---|---|---|---|
MerchantID | Yes | int | Merchant ID | 54321 |
StatusID | Yes | int | Status ID | 30 |
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 |
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 |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchantStatus"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{"MerchantID":"2378148","StatusID":"10"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchantStatus", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"MerchantID":"2378148","StatusID":"10"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/UpdateMerchantStatus", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{"MerchantID":"2378148","StatusID":"10"}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
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 |
Field Name | Field Type | Description |
---|---|---|
MerchantID | int | Merchant ID |
StatusID | int | *See status table |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/GetMerchant"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{"MerchantID":"2378148"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/GetMerchant", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"MerchantID":"2378148"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/GetMerchant", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{"MerchantID":"2378148"}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |
Parameter | Mandatory | Type | Description |
---|---|---|---|
MerchantID | Yes | int | Merchant ID |
Field Name | Field Type | Description |
---|---|---|
Code | Integer | |
IsSuccess | Boolean | |
Key | String | |
Message | String | See Return Codes Table* |
Number | String |
1 2 3 4 5 6 7 8 9 10 | var client = new RestClient("https://webservices.gr8pay.com/v2/Merchant.svc/ListMerchantStatus"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddHeader("applicationToken", "fed45b9d-429f-449e-96a7-48ea02d8156a"); request.AddHeader("your_app_Token", "fd8e72b2-a769-4d2b-a656-f54001aaeaf5"); request.AddHeader("Signature", "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM="); request.AddParameter("application/json", "{"PartnerID":"625"}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | var settings = { "url": "https://webservices.gr8pay.com/v2/Merchant.svc/ListMerchantStatus", "method": "POST", "timeout": 0, "headers": { "Content-Type": "application/json", "applicationToken": "fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token": "fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature": "bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" }, "data": JSON.stringify({"PartnerID":"625"}), }; $.ajax(settings).done(function (response) { console.log(response); }); |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | <!--?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL =--> "https://webservices.gr8pay.com/v2/Merchant.svc/ListMerchantStatus", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS =>"{"PartnerID":"625"}", CURLOPT_HTTPHEADER => array( "Content-Type: application/json", "applicationToken: fed45b9d-429f-449e-96a7-48ea02d8156a", "your_app_Token: fd8e72b2-a769-4d2b-a656-f54001aaeaf5", "Signature: bytes-SHA256, gXHd26EEryaHT7dtDSMkEkFwDkSWjb9j1HGvN2jVghM=" ), )); $response = curl_exec($curl); curl_close($curl); echo $response; |