Versions Compared

Key

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

...

URL: https://secure1.sandbox.directpay.online/API/v7/index.php


Variables to send:


Parameter

Data type

Description


 Request

 Text

 createAccount

Mandatory

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

CustomerEmail

Text

Customer Email address

Mandatory

CustomerFirstName

Text

Customer first name

Mandatory

CustomerLastName

Text

Customer last name

Mandatory

CustomerPhone

Text

Customer phone number

Mandatory

CustomerDialCode

ISO code

Customer country ISO 2 letter code
http://en.wikipedia.org/wiki/ISO_3166-1

Mandatory

CustomerPassword

Text

6 chars minimum. Allows characters like !@#$%&()?

Optional

CustomerAddress

Text

Customer address

Optional

CustomerCity

Text

Customer city

Optional

CustomerCountry

ISO code

Customer country ISO 2 letter code
http://en.wikipedia.org/wiki/ISO_3166-1

Optional

CustomerZip

Text

Customer zip code

Optional

CustomerVerify

Text

Verify “mobile” or “creditCard”
(Default: none)

Optional

CustomerCreditCard

Text

Customer credit card number

Mandatory/Optional if CustomerVerify is creditCard

CustomerExpiry

Text

Customer credit card expiry date (MM/YY)

Mandatory/Optional if CustomerVerify is “creditCard”

CustomerCvv

Text

Customer credit card CVV

Mandatory/Optional if CustomerVerify is “creditCard”

CustomerHolderName

Text

Customer credit card holder name

Mandatory/Optional if CustomerVerify is “creditCard”

CustomerMno

Text

MNO for verify payment

Mandatory/Optional if CustomerVerify is “mobile”

CustomerMnoCountry

Text

MNO country, for example: “Kenya“

Mandatory/Optional if CustomerVerify is “mobile”

CustomerMnoPhone

Text

Phone number for mobile payment

Mandatory/Optional if CustomerVerify is “mobile”


Request example:

Request example creditCard verify

...

Code Block
<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>90EC1DA4-A7C5-432C-930C-098715D3130E</CompanyToken>
  <Request>createAccount</Request>
  <CustomerVerify>mobile</CustomerVerify>
  <CustomerEmail>test@directpay.online</CustomerEmail>
  <CustomerPassword>12345678</CustomerPassword>
  <CustomerFirstName>Josh</CustomerFirstName>
  <CustomerLastName>Grinberg</CustomerLastName>
  <CustomerAddress>Rose Avenue 14</CustomerAddress>
  <CustomerCity>Nairobi</CustomerCity>
  <CustomerCountry>KE</CustomerCountry>
  <CustomerDialCode>KE</CustomerDialCode>
  <CustomerPhone>0553231231</CustomerPhone>
  <CustomerZip>762132</CustomerZip>
  <CustomerMno>SafaricomC2B</CustomerMno>
  <CustomerMnoCountry>Kenya</CustomerMnoCountry>
  <CustomerMnoPhone>25412345678</CustomerMnoPhone>
</API3G>

Respond:


The server will respond for the createAccount request according to the following results:

...

Parameter

Data type

Description

Code Block
Code

Number

Resault code

Code Block
Explanation

Text

Free text of the response

Code Block
customerToken

Token

Unique customer token to operate payments

Code Block
mobileToken

Token

Unique customer mobile token to operate mobile payments

Code Block
subscriptionToken

Token

Unique Subscription Token to operate payments

cardType

Text

Credit card brand

cardLast4

Text

Credit card last 4 digits

MnoPhone

Text

Payment phone number

MnoCountry

Text

Mno Country for verify number

Mno

Text

Mno for verify number


Respond example:

response example creditCard verify

...