Description
The merchantOnBoarding will create new Merchant accountwithin account within DPO system.
URL: https://secure1.sandbox.directpay.online/API/v6/
...
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 |
| ContactFirstName | Text | Contact person first name | Mandatory |
| ContactLastName | Text | Contact person last name | Mandatory |
| ContactPhoneNumber | Text | Contact person phone number include international prefix | Mandatory |
| MerchantName | Text | Merchant business name | Mandatory |
| MerchantRegisteredName | Text | Merchant Merchant brand name | Mandatory |
| MerchantCountry | ISO code | Merchant country ISO 2 letter code http://en.wikipedia.org/wiki/ISO_3166-1 | Mandatory |
| MerchantCity | Number | Merchant city based on list shared by DPO | Mandatory |
| MerchantUrl | Text | Valid HTTP endpoint for PuahPayment PushPayment notifications | Optional |
| IdFileTypeMerchantAddress | TextFile type | Merchant address | Mandatory |
| MerchantAccountType | Number | Merchant account based on predefined available list shared by DPO | Mandatory |
| IdBase64 | Base64 | Base 64 encoded string | Mandatory |
| CoiFileTypeOptional | |||
| MerchantIncorpDate | Date | Date format - YYYY/MM/DD | Optional |
| FileTypeId | Number | File type ID based on list shared by DPO | Optional |
| FileType | Text | File type based on predefined available list shared by DPO | MandatoryOptional |
| CoiBase64FileBase | Base64 | Base 64 encoded stringMandatory | Optional |
| MerchantNotificationUrl | URL | Merchant's URL for sending notifications on first file upload | Optional |
| MerchantDisableEmail | Boolean | Send email to merchant | Optional |
Request example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?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> <IdFile> <IdFileType>jpg</IdFileType> <IdBase64>Base 64 valid string</IdBase64> </IdFile> <CoiFile> <CoiFileType>jpg</CoiFileType> <CoiBase64>Base 64 valid string</CoiBase64> </CoiFile> <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> |
Respond:
The server will respond for the merchantOnBoarding request according to the following results:
Parameter | Data type | Description | |
Result | 3 digits code | A code will be sent with the result of the request | |
ResultExplanation | Text | Free text of the result | |
CompanyData.CompanyToken | Token | CompanyToken to operate DPO's API's on behalf of the on boarded merchant | |
| QrStringCompanyData.CompanyId | Text | mVisa static QR code string | |
| MvisaCode | 3 digits code | A code will be sent in case mVisa QR code failed to be generated 999 – Error | |
| MvisaError | Text | Free text of the mVisa generation errorNumber | Company id |
| CompanyData.UploadFiles | URL | A link to upload files form for the onboarded merchant | |
| CompanyData.CompanyCode | Text | CompanyCode | |
| CompanyData.coId | Number | Country id | |
| CompanyData.services.name | Text | Company service name | |
| CompanyData.services.id | Number | Company service id |
Respond example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utfUTF-8"?> <API3G> <CompanyData> <CompanyId>9556</CompanyId> <CompanyToken>9EF044**************************F99B</CompanyToken> <Result>000</Result> <ResultExplanation>Merchant has been created</ResultExplanation> <CompanyToken>83C37BB7-12B1-4727-AB15-3710FD97EF7A</CompanyToken> <QrString>00020101021102124039848455585204787853034045802KE5909ffgfdgfad6007Nairobi6304</QrString> <UploadFiles> https://secure.3gdirectpay.com/external/uploadfileform/uploadfileform.php?token=9EF044**************************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> |
Response codes:
Code | Explanation |
000 | Success |
999 | Error |
...