Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

...

Parameter

Data type

Description


 Request

 Text

merchantOnBoarding

Mandatory

CompanyToken

Token

Token you got from DPO to operate this API

Mandatory

ContactEmail

Text

Contact person email address

Mandatory

ContactFirstNameTextContact person first nameMandatory
ContactLastNameText

Contact person last name

Mandatory
ContactPhoneNumberText

Contact person phone number include international prefix 

Mandatory
MerchantNameTextMerchant brand nameMandatory
MerchantRegisteredNameTextMerchant business nameMandatory
MerchantCountryISO codeMerchant country ISO 2 letter code
http://en.wikipedia.org/wiki/ISO_3166-1
Mandatory
MerchantCityNumberMerchant city based on list shared by DPOMandatory
MerchantUrlTextValid HTTP endpoint for PuahPayment notificationsOptional
MerchantAddressTextMerchant addressMandatory
MerchantAccountTypeNumberMerchant account based on list shared by DPOOptional
MerchantIncorpDateDateDate format - YYYY/MM/DDOptional
FileTypeIdNumberFile type ID based on list shared by DPOOptional
FileTypeTextFile type based on predefined available list shared by DPOOptional
FileBaseBase64Base 64 encoded stringOptional
MerchantNotificationUrlURLMerchant's URL for sending notifications on first file uploadOptional
MerchantDisableEmailBooleanSend email to merchantOptional

...

Code Block
languagexml
titlerequest example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
	<Request>merchantOnBoarding</Request>
	<CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C55RVE<<CompanyToken>68B90B**************************5RVE</CompanyToken>
	<ContactEmail>test@directpay.online</ContactEmail>
	<ContactFirstName>John</ContactFirstName>
	<ContactLastName>Green</ContactLastName>
	<ContactPhoneNumber>254556555656</ContactPhoneNumber>
	<MerchantName>DPO test merchant</MerchantName>
	<MerchantRegisteredName>DPO test merchant 1</MerchantRegisteredName>
	<MerchantCountry>KE</MerchantCountry>
	<MerchantAddress>Rose Ave 5</MerchantAddress>
	<MerchantCity>114</MerchantCity>
	<MerchantUrl>http://www.directpay.online</MerchantUrl>
	<MerchantAccountType>1</MerchantAccountType>
	<MerchantIncorpDate>2017/12/25</MerchantIncorpDate>
	<MerchantNotificationUrl>www.directpay.online/notification.php</MerchantNotificationUrl>
	<MerchantDisableEmail>0</MerchantDisableEmail>
	<Files>
		<File>
			<FileTypeId>1</FileTypeId>
			<FileType>jpg</FileType>
			<FileBase>base 64 string</FileBase>
		</File>
		<File>
			<FileTypeId>1</FileTypeId>
			<FileType>pdf</FileType>
			<FileBase>base 64 string</FileBase>
		</File>
	</Files>
</API3G>

...

Code Block
languagexml
titleresponse example
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
	<CompanyData>
		<CompanyToken>9EF044A5-AAD7-434E-AA1C-8A6962CAF99B<<CompanyToken>9EF044**************************F99B</CompanyToken>
		<UploadFiles>
			https://secure.3gdirectpay.com/external/uploadfileform/uploadfileform.php?token=FEC8707D-32ED-413D-96C1-F452A38B29999EF044**************************F99B
		</UploadFiles>
		<CompanyCode>HKRUA</CompanyCode>
		<coId>2</coId>
		<services>
			<service>
				<name>PC</name>
				<id>30008</id>
			</service>
			<service>
				<name>Flight</name>
				<id>30009</id>
			</service>
		</services>
	</CompanyData>
	<Result>000</Result>
	<ResultExplanation>Merchant has been created</ResultExplanation>
</API3G>

...