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 |
| 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 brand name | Mandatory |
| MerchantRegisteredName | Text | Merchant business 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 notifications | Optional |
| MerchantAddress | Text | Merchant address | Mandatory |
| MerchantAccountType | Number | Merchant account based on list shared by DPO | Optional |
| 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 | Optional |
| FileBase | Base64 | Base 64 encoded string | Optional |
| MerchantNotificationUrl | URL | Merchant's URL for sending notifications on first file upload | Optional |
Request example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?>
<API3G>
<Request>merchantOnBoarding</Request>
<CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C55RVE</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>
<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> |
...
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 |
CompanyToken | Token | CompanyToken to operate DPO's API's on behalf of the on boarded merchant |
| UploadFiles | URL | A link to upload files form for the onboarded merchant |
Respond example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?>
<API3G>
<Result>000</Result>
<ResultExplanation>Merchant has been created</ResultExplanation>
<CompanyToken>83C37BB7-12B1-4727-AB15-3710FD97EF7A</CompanyToken>
<UploadFiles>https://secure.3gdirectpay.com/external/uploadfileform/uploadfileform.php?token=D7B6E822-26A5-43AF-A9AB-201B6CC6987E</UploadFiles>
</API3G> |
Response codes:
Code | Explanation |
000 | Success |
999 | Error |
...