Description
The verifyToken request can be initiated at any time, and it is mandatory to verify the token when the customer will return to the application, not verifying the token within 30 minutes of transaction completed of payment, will generate an alert e-mail to the provider announcing that there was no verification process.
URL: https://secure1secure.sandbox3gdirectpay.directpay.onlinecom/API/v6/
...
Request
The method will response respond with the result of your request
Variables to send:
Parameter | Data type | Description | |
| CompanyToken | Token | Token you got from 3G to operate this API | Mandatory |
Request | Text | verifyToken | Mandatory |
TransactionToken | Token | Transaction token as accepted from the URL redirected |
Mandatory |
VeirfyTransaction
Number
(0 or 1)
/Optional if CompanyRef is sent | |||
| CompanyRef | Text | Company reference number | Mandatory/Optional if TransactionToken is sent |
VerifyTransaction | Boolean (1/0) | By default, the system will verify the transaction and mark it as “website verified” in 3G systems. Send 1 to verify, 0 if you don't need. | Optional |
CompanyRef
Text
Company reference number.
Optional
Default: 1 (True) | |||
ACCref | Text | Internal accounting reference number. | Optional |
customerPhone | Text | Customer phone number can be updated |
Optional/Mandatory if customerPhonePrefix sent | ||
customerPhonePrefix | Number | Customer phone prefix (without +) |
Optional/Mandatory if customerPhone sent |
customerEmail | Text | Customer E-mail address can be updated | Optional |
Request example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> <API3G> <CompanyToken>57466282-EBD7-4ED5-B699-8659330A6996</CompanyToken> <Request>verifyToken</Request> <TransactionToken>72983CAC-5DB1-4C7F-BD88-352066B71592</TransactionToken> </API3G> |
...
Response:
The server will respond for the verifyToken request according to the following results:
Parameter | Data type | Description |
Result | 3 digits code | A code will be sent with the result of the request |
ResultExplanation | Text | Free text of the result |
CustomerName | Text | Customer name as filled in the form of 3GDirectpay payment page.Will be sent if transaction paid/failed |
CustomerCredit | Text | 4 digits of credit cardWill be sent if transaction paid/failed |
CustomerCreditType | Text | Credit card type |
TransactionApproval | Text | Transaction approval numberWill be sent if transaction paid/failed |
TransactionCurrency | Text | Currency final payment (the customer can convert the payment)Will be sent if transaction paid/failed |
TransactionAmount | Money | Paid amount Will be sent if transaction paid/failed |
FraudAlert | 3 digits code | According to fraud codes table |
FraudExplnation | Text | Free text of fraud analysis |
TransactionNetAmount | Amount | NET transaction amount |
TransactionSettlementDate | Date | Date of transaction settlement |
TransactionRollingReserveAmount | Amount | Transaction rolling reserve amount |
TransactionRollingReserveDate | Date | Date of rolling reserve release |
CustomerPhone | Text | Customer phone number |
CustomerCountry | Text | Customer country |
CustomerAddress | Text | Customer address |
CustomerCity | Text | Customer city |
CustomerZip | Text | Customer zip code |
TransactionRollingReserveDate | Date | Date of rolling reserve release |
MobilePaymentRequest | Text | Mobile payment request status |
AccRef | Text | Internal accounting reference number |
...
Codes in
...
response:
...
Code | Explanation |
000 | Transaction Paid |
001 | Authorized |
002 | Overpay/UnderpayTransaction overpaid/underpaid |
| 003 | Pending Bank |
| 005 | Queued Authorization |
| 007 | Pending Split Payment (Part Payment Transactions not fully paid) |
801 | Request missing company token |
802 | Company token does not exist |
803 | No request or error in Request type name |
804 | Error in XML |
900 | Not Paid Transaction not paid yet |
901Declined | Transaction declined |
| 902 | Data mismatch in one of the fields - field (explanation) |
903Transaction | passed PTLThe transaction passed the Payment Time Limit |
904 | Transaction cancelled |
950 | Request missing transaction level mandatory fields – TransactionToken |
951 | Data mismatch in one of the fields – VeirfyTransaction 1 or 0 |
fields – field (explanation) |
Codes in fraud alert:
Code | Explanation |
000 | Genuine transaction |
| 001 | Low Risk (Not checked) |
Fraud detected, action required,please consult 3G system or the detailed fraud reason.
002
Fraud detected, transaction blocked
...
002 | Suspected Fraud Alert |
| 003 | Fraud alert cleared (Merchant marked as clear) |
| 004 | Suspect Fraud Alert |
| 005 | Fraud alert cleared (Low Risk (Checked)/ Genuine transaction) |
| 006 | Black - Fraudulent transaction |
Response example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="utf-8"?> <API3G> <Result>000</Result> <ResultExplanation>Transaction paid<Paid</ResultExplanation> <CustomerName>Cons <CustomerNameConnie >John Doe<</CustomerName > <CustomerCredit>4432<CustomerName> <CustomerCredit></CustomerCredit> <TransactionApproval>938204312< <CustomerCreditType>Mobile</CustomerCreditType> <TransactionApproval>RHP2ZIGD5U</TransactionApproval> <TransactionCurrency>USD< <TransactionCurrency>KES</TransactionCurrency> <TransactionAmount>950 <TransactionAmount>1.00</TransactionAmount> <FraudAlert>000< <FraudAlert>001</FraudAlert> <FraudExplnation>Low <FraudExplnation>NoRisk Fraud detected<(Not checked)</FraudExplnation> <TransactionNetAmount>945< <TransactionNetAmount>0.99</TransactionNetAmount> <TransactionSettlementDate>2013 <TransactionSettlementDate>2023/1209/31<04</TransactionSettlementDate> <TransactionRollingReserveAmount>5< <TransactionRollingReserveAmount>0.00</TransactionRollingReserveAmount> <TransactionRollingReserveDate>2014 <TransactionRollingReserveDate>2023/1208/31<25</TransactionRollingReserveDate> <CustomerPhone>254123456789< <CustomerPhone>706527126</CustomerPhone> <CustomerCountry>KE< <CustomerCountry>Kenya</CustomerCountry> <CustomerAddress>Stranfe blvd.< <CustomerAddress></CustomerAddress> <CustomerCity>Nairobi< <CustomerCity>Mbsa</CustomerCity> <CustomerZip>AH1< <CustomerZip></CustomerZip> <MobilePaymentRequest>Not <MobilePaymentRequest>Sent<sent</MobilePaymentRequest> <AccRef>ABC123REF</AccRef> <AccRef></AccRef> <TransactionFinalCurrency>KES</TransactionFinalCurrency> <TransactionFinalAmount>1.00</TransactionFinalAmount> </API3G> |
...