Description
...
- Transaction level – Mandatory - Contains all the basic transaction information
- Services level – Mandatory - Contains all the information regarding the services sold in the transaction – must contain at-least one service
- Allocations level – Contains all the information regarding the allocation of money received from transaction to be paid to other providers in Direct Pay Online system. If this level is not sent, the system will allocate all the money from this transaction to the provider
- Additional level – Contains an option to block specific payment options in the transaction (for example, on an application which needs fast payment, block off Direct Pay Online bank payment)
- Travelers level – Contains information regarding travelers (passengers / guests) which will a process in Direct Pay Online system to verify that one of the payers name matches the name of one of the travelers
URL: https://secure1secure.sandbox3gdirectpay.directpay.onlinecom/API/v6/
Response
The method will respond with the result of your request.
...
Parameter | Data type | Description | |
CompanyToken | Token | Token you got from 3G to operate this API | Mandatory |
| Request | Text | createToken | Mandatory |
...
Parameter | Data type | Description | |||||
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, i.e also referred to as Booking ref | Optional | ||||
RedirectURL | Text | URL to redirect the customer after the payment.
| 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:
| Optional. Default: 1 (Charge) | ||||
TransactionAutoChargeDate | DateTime | Date and time of automatic charge of transaction, if authorized by that date. | 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 | 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 | Text | The code of the default payment option (the one to be displayed first in the payment page), options:
| Optional | ||||
| DefaultPaymentCountry | 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> | Optional | ||||
DefaultPaymentMNO | Text | 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> | Optional | ||||
| TransactionToPrep | Boolean (1/0) | Will mark the transaction as Marketplace Prep | Optional | ||||
AllowRecurrent | Boolean (1/0) | Will allow payment via recurrent | Optional | ||||
| FraudTimeLimit | Number | Set fraud time limit in minutes (from current date) | Optional | ||||
| Voidable | Boolean (1/0) | If this tag sent, transaction will be checked in scoring process, if 0 and scoring above high risk/very high risk then will be blocked, if 1 then will go to a check by DPO support team | Optional | ||||
| ChargeType | Text | Optional | |||||
| TRANSmarketplace | Number | If this tag is sent, allocation amount will be update based on the API_GetCCTclientprecentage stored proc | Optional | ||||
| TRANSblockCountries | Boolean (1/0) | transaction block countries | Optional | ||||
| MetaData | Text(2000) | Some custom data, that need store for specify transaction (Max allowed 2000 symbols) | Optional | ||||
| SMSTransaction | Boolean (1/0) | sms transaction | Optional | ||||
| TransactionType | Text | If set, update the transaction status id based on it | Optional | ||||
| DeviceId | Text | In use if transaction type is duma directpay | Optional | ||||
| DeviceCountry | Text | In use if transaction type is duma directpay | Optional | ||||
TransactionSource | Text | This field will indicate the source of the transaction. If none provided the default source will be applied (default = API). Available sources (more can be added if needed):
| Optional |
Service level (Mandatory):
...
Parameter | Data type | Description | |
ServiceDescription | Text | The description of the payment made | Mandatory |
ServiceType | Number | Service type number according to the options accepted from DPO | Mandatory-Optional (Need send ServiceType or ServiceTypeName) |
| ServiceTypeName | Text | Service type name according to the options accepted from DPO | Mandatory-Optional (Need send ServiceType or ServiceTypeName) |
ServiceDate | DateTime | Service date of the booked service | Mandatory |
ServiceFrom | Iata | 3 letters departure airport code | Optional |
ServiceTo | Iata | 3 letters destination airport code | Optional |
| ServiceRef | Text | Service Reference | Optional |
...
Allocations must be wrapped in <Allocations> tag and each allocation in <Allocation> tag. The limit for an allocation must be the 95% 89% of the total of the transaction. Some fields are mandatory for each allocation sent.
...
Parameter | Data type | Description | |
BlockPayment | Text | The code of the payment options to be blocked, options: MO – Mobile PP – PayPal BT – Bank transfer XP – xPay SE - SID-EFT CP - USSD(coral Pay) | Optional |
Travelers level (Optional):
...
Parameter | Data type | Description | Is Mandatory |
TicketType DocumentType DateIssued IATACarrierCode IATATravelAgencyNbr TicketCarrierName TicketIssuerCityName PassengerCount ConjTicketIndicator ElecTicketIndicator TicketNumber FlightLegDetails Travelers | Text Text DateTime Text Text Text Text Numeric Text Text Text XML (String) XML (String) | Ticket Type Document Type Date Issued IATA Carrier Code IATA Travel Agency Number Ticket Carrier Name Ticket Issuer City Name Number of Passengers Conjunction Ticket Indicator Electronic Ticket Indicator Exchanged/Original Ticket No or PNR Flight Leg Details Traveler Details | Optional Optional Mandatory Mandatory Optional Optional Optional Optional Optional Optional Mandatory Optional Optional |
Traveler Details Prams:
Parameter | Data type | Description | Is Mandatory |
TravelerFirstName | Text | First name | Mandatory |
TravelerLastName | Text | Last name | Mandatory |
TravelerPhone | Text | Phone number | Optional |
TravelerPhonePrefix | Numeric | Phone number prefix (without +) | Optional |
| TravelerDateOfBirth | DateTime | Traveler Date Of Birth | Optional |
| TravelerCountryCode | Text | Traveler Country Code | Optional |
...
Parameter | Data type | Description | Is Mandatory |
FlightDescription | Text | The description of the payment made | Mandatory |
FlightType | Number | Service type number according to the options accepted from DPO | Mandatory |
FightDate | DateTime | Service date of the booked service | Mandatory |
FlightFrom | Text | 3 letters departure airport code | Mandatory |
FightTo | Text | 3 letters destination airport code | Mandatory |
FlightRef | Text | Service Reference | Optional |
CarrierCode | Text | IATA carrier code | Mandatory |
ServiceClass | Text | Service Class | Mandatory |
FlightNumber | Text | Flight Number | Mandatory |
FareBasisCode | Text | Fare Basis Code | Mandatory |
StopOverCode | Text | Stop Over Code | Mandatory |
...
NOTE; Payment page URL is: https://secure1secure.sandbox.directpay.online3gdirectpay.com//payv2.php?ID={{TransToken}}
For example: https://secure1secure.sandbox.directpay.online3gdirectpay.com//payv2.php?ID=72983CAC-5DB1-4C7F-BD88-352066B71592
...