Page Comparison

Parameter

Data type

Description

 CompanyToken

 Token

Token you got from 3G to operate this API

Mandatory

Parameter

Data type

Description

 Request

 Text

 createToken

Mandatory

PaymentAmount

Money

Total amount in the selected currency. No more than 2 digits after the comma

Mandatory

PaymentCurrency

Text

From table of options as accepted from DPO

Mandatory

CompanyRef

Text

Company reference number

Optional

RedirectURL

Text

URL to redirect the customer after the payment.
The customer will be redirected to this URL with the below variables in GET method.
You can send your link with additional variables, the system will recognize it and the additional variables will be sent out with “&” instead of “?” in the beginning.
Variables:

• TransID - Transaction ref.
• CCDapproval - Approval number
• PnrID - Customer ref
• TransactionToken - Transaction ref. (repeated)
• CompanyRef - Customer ref. (repeated)

Optional

BackURL

Text

URL to let the customer go back from the payment page.

The customer will be redirected to this URL with "TransactionToken" and "CompanyRef" variables in GET method. You can send your link with additional variables, the system will recognize it and the additional variables will be sent our with "&" instead of "?" in the beginning

Optional

DeclinedURL

Text

URL to return the client if payment is declined. You can send your link with additional variables, the system will recognize it and the additional variables will be sent out with “&” instead of “?” in the beginning

Optional

CompanyRefUnique

Boolean

Tells the system to verify if the company reference number (transaction ID given by the provider) given is already in the system and paid, if so, returns error to API result.This is to prevent double payments

Optional.

Default: False

PTL

Number

Number of hours to payment time limit

Optional.

Default: 96 hours

PTLtype

Text

Define if “PTL” tag is hours or minutes. options: “hours” or “minutes”

Optional.

Default: hours

TransactionChargeType

Number

Type of transaction:

• 1 for Charge - immediate charge
• 2 for Authorize-Manual - for an authorization process and then manual charge using “chargeToken”
• 3 for Authorize-Auto - for authorization process and then automatically charge on chosen date

Optional.

Default: 1 (Charge)

TransactionAutoChargeDate

DateTime

Date and time of automatic charge of transaction, if authorized by that date.
Formats: YYYY/MM/DD HH:MM(:SS), YYYY/MM/DD, YYYY-MM-DD HH:MM(:SS), YYYY-MM-DD

Optional/Mandatory if TransactionChargeType=”Authorize-Auto”

customerEmail

Text

E-mail of the customer to send the link

Optional

customerFirstName

Text

Customer name

Optional

customerLastName

Text

Customer last name

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

customerDialCode

ISO code

Customer country ISO 2 letter code

Optional

customerPhone

Number

Customer Phone number

Optional

customerZip

Text

Customer zip code

Optional

DemandPaymentbyTraveler

Boolean (1/0)

If marked as 1, the system will require one of the travelers which are included in the travelers tag to be the payer.

Optional

EmailTransaction

Boolean (1/0)

If marked as 1, the system will send the customer an e-mail about the transaction with a link to pay

Optional

CompanyAccRef

Text

Internal accounting reference number

Optional

userToken

Token

To define who created the transaction

Optional

DefaultPayment

The code of the default payment option (the one to be displayed first in the payment page), options:

• CC – Credit card
• MO – Mobile
• PP – PayPal
• BT – Bank transfer
• XP – xPay

Text

Should be used only for Mobile default payment.

Name of the default country for the payment option (DefaultPayment will work without this option too)

Ex.: <DefaultPaymentCountry>kenya</DefaultPaymentCountry>

DefaultPaymentMNO

Should be used only for Mobile default payment.

Name of the default MNO (mobile network operator) for the payment option (DefaultPayment will work without this option too)

Ex.: <DefaultPaymentMNO>mpesa</DefaultPaymentMNO>

AllowRecurrent