Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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://secure1.sandbox.directpay.online/API/v6/

 

Response

The method will response with the result of your request

 

Variables to send:

Parameter

Data type

Description


 Request

 Text

 verifyToken

Mandatory

TransactionToken

Token

Transaction token as accepted from the URL redirected.

Mandatory

VeirfyTransaction

Number

(0 or 1)

Default: True
By default, the system will verify the transaction and mark it as “website verified” in 3G systems.
This option should be set to false if you only want to verify the transaction was made, process the details and then you can send the verifyToken again with this parameter set to true to let 3G systems know that you have successfully processed the client.

Send 1 to verify, 0 if you don't need.

Optional

CompanyRef

Text

Company reference number.

Optional

ACCref

Text

Internal accounting reference number.

Optional

customerPhone

Text

Customer phone number can be updated. customerPhonePrefix is mandatory when sending this field

Optional

customerPhonePrefix

Number

Customer phone prefix (without +), mandatory if customerPhone sent

Optional

customerEmail

Text

Customer E-mail address can be updated

Optional

Request example:


request example
<?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>


Respond:

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 respond:

 

Code

Explanation

000

Transaction Paid

001

Authorized

002

Overpay/Underpay

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 yet

901

Declined

903

Transaction passed PTL

904

Transaction cancelled

950

Request missing transaction level mandatory fields – TransactionToken

951

Data mismatch in one of the fields – VeirfyTransaction 1 or 0

 

Codes in fraud alert:

 

Code

Explanation

000

Genuine transaction

001

Fraud detected, action required,please consult 3G system or the detailed fraud reason.

002

Fraud detected, transaction blocked

 

Respond example:


response example
<?xml version="1.0" encoding="utf-8"?>
<API3G>
 <Result>000</Result>
 <ResultExplanation>Transaction paid</ResultExplanation>
 <CustomerName >John Doe</CustomerName >
 <CustomerCredit>4432</CustomerCredit>
 <TransactionApproval>938204312</TransactionApproval>
 <TransactionCurrency>USD</TransactionCurrency>
 <TransactionAmount>950.00</TransactionAmount>
 <FraudAlert>000</FraudAlert>
 <FraudExplnation>No Fraud detected</FraudExplnation>
 <TransactionNetAmount>945</TransactionNetAmount>
 <TransactionSettlementDate>2013/12/31</TransactionSettlementDate>
 <TransactionRollingReserveAmount>5</TransactionRollingReserveAmount>
 <TransactionRollingReserveDate>2014/12/31</TransactionRollingReserveDate>
 <CustomerPhone>254123456789</CustomerPhone>
 <CustomerCountry>KE</CustomerCountry>
 <CustomerAddress>Stranfe blvd.</CustomerAddress>
 <CustomerCity>Nairobi</CustomerCity>
 <CustomerZip>AH1</CustomerZip>
 <MobilePaymentRequest>Sent</MobilePaymentRequest>
 <AccRef>ABC123REF</AccRef>
</API3G>


 

 

 

  • No labels