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 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 | |||
| IdFileTypeMerchantAccountType | TextNumber | File type Merchant account based on predefined available list shared by DPO | MandatoryOptional | |||
| IdBase64FileTypeId | Base64 | Base 64 encoded string | Mandatory | CoiFileTypeNumber | 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 string | MandatoryOptional |
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> <MerchantCountry>KE</MerchantCountry> <MerchantCity>114</MerchantCity> <MerchantUrl>http://www.directpay.online</MerchantUrl> <IdFile><MerchantAccountType>1</MerchantAccountType> <Files> <File> <FileTypeId>1</FileTypeId> <IdFileType>jpg< <FileType>jpg</IdFileType>FileType> <IdBase64>Base <FileBase>base 64 valid string</IdBase64>FileBase> </IdFile> <CoiFile>File> <File> <FileTypeId>1</FileTypeId> <CoiFileType>jpg< <FileType>pdf</CoiFileType>FileType> <CoiBase64>Base <FileBase>base 64 valid string</CoiBase64>string</FileBase> </File> </CoiFile>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 |
CompanyToken | Token | CompanyToken to operate DPO's API's on behalf of the on boarded merchant |
| QrString | Text | mVisa static QR code string |
| MvisaCode | 3 digits code | A code will be sent in case mVisa QR code failed to be generated999 – Error |
| MvisaError | Text | Free text of the mVisa generation error |
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>
<QrString>00020101021102124039848455585204787853034045802KE5909ffgfdgfad6007Nairobi6304</QrString>
</API3G> |
Response codes:
Code | Explanation |
000 | Success |
999 | Error |
...