Versions Compared

Key

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

...

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”

CustomerGlobalAccountCustomerAllowSWrefunds

Bool

Verify credit card via global current company account (default 0)

Optional

CustomerHolderName

Text

Customer credit card holder name

Mandatory/Optional if CustomerVerify is “creditCard”

CustomerThreeD

XML (String)

Customer credit card 3D data (if need verify 3D credit card )

Optional

CustomerSendWelcomeEmail

Bool

Allow send verify email, default - 1

Optional

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”

...

Parameter

Data type

Description

Enrolled

Text

3D param, mandatory for PG3D, MIGS3D

Optional

Paresstatus

Text

3D param, mandatory for PG3D, MIGS3D(vpc_3DSstatus)

Optional

Eci

Text

3D param, mandatory for all terminal types

MandatoryOptional

Xid

Text

3D param, mandatory for all terminal types

MandatoryOptional

Cavv

Text

3D param, mandatory for all terminal types

MandatoryOptional

Signature

Text

3D param, mandatory for PG3D

Optional

Veres

Text

3D param, mandatory for MPGS3D, MIGS3D, MPGS3DAirlines

Optional

Pares

Text

3D param, mandatory for MPGS3D, MPGS3DAirlines

Optional

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>creditCard</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>
  <CustomerCreditCard>4111111111111111</CustomerCreditCard>
  <CustomerExpiry>1225</CustomerExpiry>
  <CustomerCvv>123</CustomerCvv>
  <CustomerHolderName>Josh Grinberg</CustomerHolderName>
  <CustomerAllowSWrefunds>1</CustomerAllowSWrefunds>
  <CustomerGlobalAccount>1<<CustomerSendWelcomeEmail>0</CustomerGlobalAccount>CustomerSendWelcomeEmail>
  <CustomerThreeD>
      <Enrolled>fkf></Enrolled>
      <Paresstatus>Y</Paresstatus>
      <Eci>05</Eci>
      <Xid>DYYVcrwnujRMnHDy1wlP1Ggz8w0=</Xid>
      <Cavv>mHyn+7YFi1EUAREAAAAvNUe6Hv8=</Cavv>
      <Signature>_</Signature>
      <Veres>AUTHENTICATION_SUCCESSFUL</Veres>
      <Pares>eAHNV1mzokgW\/is</Pares>
  </CustomerThreeD>
</API3G>

...

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <Code>903</Code>
	<Explanation>Terminal was not found . Please try again or contact to support team</Explanation>
</API3G>

Respond:

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

Parameter

Data type

Description

Result

3/4 digits code

A code will be sent with the result of the request

Explanation

Text

Free text of the result

Respond codes:

Code

Explanation

000

Successfully created account

900

Create Account Error CompanyToken wrong

903

Create account error. Please try again or contact to support team (Internal process error)

902

company / subsidiary company was not found

901,

Data mismatch in one of the fields – fieldname

804

Error in XML

950

Request missing mandatory fields – fieldname