Description
...
Parameter | Data type | Description | |
CompanyToken | Token | Token you got from 3G to operate this API | Mandatory |
| Request | Text | createToken | 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, 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 |
...
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 |
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 |
...